Skip to content

Latest commit

 

History

History
723 lines (721 loc) · 384 KB

File metadata and controls

723 lines (721 loc) · 384 KB
Method Description
ActionsAddRepoAccessToSelfHostedRunnerGroupInOrg(org, runner_group_id, repository_id) Adds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see "Create a self-hosted runner group for an organization."
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsAddSelectedRepoToOrgSecret(org, secret_name, repository_id) Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
ActionsAddSelfHostedRunnerToGroupForOrg(org, runner_group_id, runner_id) Adds a self-hosted runner to a runner group configured in an organization.
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsCancelWorkflowRun(owner, repo, run_id) Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
ActionsCreateOrUpdateEnvironmentSecret(repository_id, environment_name, secret_name) Creates or updates an environment secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use
this endpoint.

#### Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

<br>const sodium = require('tweetsodium');<br><br>const key = "base64-encoded-public-key";<br>const value = "plain-text-secret";<br><br>// Convert the message and key to Uint8Array's (Buffer implements that interface)<br>const messageBytes = Buffer.from(value);<br>const keyBytes = Buffer.from(key, 'base64');<br><br>// Encrypt using LibSodium.<br>const encryptedBytes = sodium.seal(messageBytes, keyBytes);<br><br>// Base64 the encrypted secret<br>const encrypted = Buffer.from(encryptedBytes).toString('base64');<br><br>console.log(encrypted);<br>


#### Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

<br>from base64 import b64encode<br>from nacl import encoding, public<br><br>def encrypt(public_key: str, secret_value: str) -> str:<br> \"""Encrypt a Unicode string using the public key.\"""<br> public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())<br> sealed_box = public.SealedBox(public_key)<br> encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))<br> return b64encode(encrypted).decode("utf-8")<br>

#### Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

<br>var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");<br>var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");<br><br>var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);<br><br>Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));<br>

#### Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

ruby<br>require "rbnacl"<br>require "base64"<br><br>key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")<br>public_key = RbNaCl::PublicKey.new(key)<br><br>box = RbNaCl::Boxes::Sealed.from_public_key(public_key)<br>encrypted_secret = box.encrypt("my_secret")<br><br># Print the base64 encoded secret<br>puts Base64.strict_encode64(encrypted_secret)<br>
ActionsCreateOrUpdateOrgSecret(org, secret_name) Creates or updates an organization secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to
use this endpoint.

#### Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

<br>const sodium = require('tweetsodium');<br><br>const key = "base64-encoded-public-key";<br>const value = "plain-text-secret";<br><br>// Convert the message and key to Uint8Array's (Buffer implements that interface)<br>const messageBytes = Buffer.from(value);<br>const keyBytes = Buffer.from(key, 'base64');<br><br>// Encrypt using LibSodium.<br>const encryptedBytes = sodium.seal(messageBytes, keyBytes);<br><br>// Base64 the encrypted secret<br>const encrypted = Buffer.from(encryptedBytes).toString('base64');<br><br>console.log(encrypted);<br>


#### Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

<br>from base64 import b64encode<br>from nacl import encoding, public<br><br>def encrypt(public_key: str, secret_value: str) -> str:<br> \"""Encrypt a Unicode string using the public key.\"""<br> public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())<br> sealed_box = public.SealedBox(public_key)<br> encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))<br> return b64encode(encrypted).decode("utf-8")<br>

#### Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

<br>var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");<br>var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");<br><br>var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);<br><br>Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));<br>

#### Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

ruby<br>require "rbnacl"<br>require "base64"<br><br>key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")<br>public_key = RbNaCl::PublicKey.new(key)<br><br>box = RbNaCl::Boxes::Sealed.from_public_key(public_key)<br>encrypted_secret = box.encrypt("my_secret")<br><br># Print the base64 encoded secret<br>puts Base64.strict_encode64(encrypted_secret)<br>
ActionsCreateOrUpdateRepoSecret(owner, repo, secret_name) Creates or updates a repository secret with an encrypted value. Encrypt your secret using
LibSodium. You must authenticate using an access
token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use
this endpoint.

#### Example encrypting a secret using Node.js

Encrypt your secret using the tweetsodium library.

<br>const sodium = require('tweetsodium');<br><br>const key = "base64-encoded-public-key";<br>const value = "plain-text-secret";<br><br>// Convert the message and key to Uint8Array's (Buffer implements that interface)<br>const messageBytes = Buffer.from(value);<br>const keyBytes = Buffer.from(key, 'base64');<br><br>// Encrypt using LibSodium.<br>const encryptedBytes = sodium.seal(messageBytes, keyBytes);<br><br>// Base64 the encrypted secret<br>const encrypted = Buffer.from(encryptedBytes).toString('base64');<br><br>console.log(encrypted);<br>


#### Example encrypting a secret using Python

Encrypt your secret using pynacl with Python 3.

<br>from base64 import b64encode<br>from nacl import encoding, public<br><br>def encrypt(public_key: str, secret_value: str) -> str:<br> \"""Encrypt a Unicode string using the public key.\"""<br> public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder())<br> sealed_box = public.SealedBox(public_key)<br> encrypted = sealed_box.encrypt(secret_value.encode("utf-8"))<br> return b64encode(encrypted).decode("utf-8")<br>

#### Example encrypting a secret using C#

Encrypt your secret using the Sodium.Core package.

<br>var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret");<br>var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=");<br><br>var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);<br><br>Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));<br>

#### Example encrypting a secret using Ruby

Encrypt your secret using the rbnacl gem.

ruby<br>require "rbnacl"<br>require "base64"<br><br>key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=")<br>public_key = RbNaCl::PublicKey.new(key)<br><br>box = RbNaCl::Boxes::Sealed.from_public_key(public_key)<br>encrypted_secret = box.encrypt("my_secret")<br><br># Print the base64 encoded secret<br>puts Base64.strict_encode64(encrypted_secret)<br>
ActionsCreateRegistrationTokenForOrg(org) Returns a token that you can pass to the config script. The token expires after one hour.

You must authenticate using an access token with the admin:org scope to use this endpoint.

#### Example using registration token

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

<br>./config.sh --url https://github.com/octo-org --token TOKEN<br>
ActionsCreateRegistrationTokenForRepo(owner, repo) Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate
using an access token with the repo scope to use this endpoint.

#### Example using registration token

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

<br>./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN<br>
ActionsCreateRemoveTokenForOrg(org) Returns a token that you can pass to the config script to remove a self-hosted runner from an organization. The token expires after one hour.

You must authenticate using an access token with the admin:org scope to use this endpoint.

#### Example using remove token

To remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this
endpoint.

<br>./config.sh remove --token TOKEN<br>
ActionsCreateRemoveTokenForRepo(owner, repo) Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.

#### Example using remove token

To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.

<br>./config.sh remove --token TOKEN<br>
ActionsCreateSelfHostedRunnerGroupForOrg(org) The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "GitHub's products."

Creates a new self-hosted runner group for an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsCreateWorkflowDispatch(owner, repo, workflow_id) You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see "Events that trigger workflows."

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see "Creating a personal access token for the command line."
ActionsDeleteArtifact(owner, repo, artifact_id) Deletes an artifact for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
ActionsDeleteEnvironmentSecret(repository_id, environment_name, secret_name) Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
ActionsDeleteOrgSecret(org, secret_name) Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
ActionsDeleteRepoSecret(owner, repo, secret_name) Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
ActionsDeleteSelfHostedRunnerFromOrg(org, runner_id) Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsDeleteSelfHostedRunnerFromRepo(owner, repo, runner_id) Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

You must authenticate using an access token with the repo
scope to use this endpoint.
ActionsDeleteSelfHostedRunnerGroupFromOrg(org, runner_group_id) Deletes a self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsDeleteWorkflowRun(owner, repo, run_id) Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
private you must use an access token with the repo scope. GitHub Apps must have the actions:write permission to use
this endpoint.
ActionsDeleteWorkflowRunLogs(owner, repo, run_id) Deletes all logs for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
ActionsDisableSelectedRepositoryGithubActionsOrganization(org, repository_id) Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
ActionsDisableWorkflow(owner, repo, workflow_id) Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
ActionsDownloadArtifact(owner, repo, artifact_id, archive_format) Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in
the response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the repo scope.
GitHub Apps must have the actions:read permission to use this endpoint.
ActionsDownloadJobLogsForWorkflowRun(owner, repo, job_id) Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
for Location: in the response header to find the URL for the download. Anyone with read access to the repository can
use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must
have the actions:read permission to use this endpoint.
ActionsDownloadWorkflowRunLogs(owner, repo, run_id) Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
Location: in the response header to find the URL for the download. Anyone with read access to the repository can use
this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have
the actions:read permission to use this endpoint.
ActionsEnableSelectedRepositoryGithubActionsOrganization(org, repository_id) Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
ActionsEnableWorkflow(owner, repo, workflow_id) Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
ActionsGetAllowedActionsOrganization(org) Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization.""

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
ActionsGetAllowedActionsRepository(owner, repo) Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for a repository."

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
ActionsGetArtifact(owner, repo, artifact_id) Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ActionsGetEnvironmentPublicKey(repository_id, environment_name) Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
ActionsGetEnvironmentSecret(repository_id, environment_name, secret_name) Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
ActionsGetGithubActionsPermissionsOrganization(org) Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
ActionsGetGithubActionsPermissionsRepository(owner, repo) Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.

You must authenticate using an access token with the repo scope to use this
endpoint. GitHub Apps must have the administration repository permission to use this API.
ActionsGetJobForWorkflowRun(owner, repo, job_id) Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ActionsGetOrgPublicKey(org) Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
ActionsGetOrgSecret(org, secret_name) Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
ActionsGetPendingDeploymentsForRun(owner, repo, run_id) Get all deployment environments for a workflow run that are waiting for protection rules to pass.

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ActionsGetRepoPublicKey(owner, repo) Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.
ActionsGetRepoSecret(owner, repo, secret_name) Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
ActionsGetReviewsForRun(owner, repo, run_id) Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ActionsGetSelfHostedRunnerForOrg(org, runner_id) Gets a specific self-hosted runner configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsGetSelfHostedRunnerForRepo(owner, repo, runner_id) Gets a specific self-hosted runner configured in a repository.

You must authenticate using an access token with the repo scope to use this
endpoint.
ActionsGetSelfHostedRunnerGroupForOrg(org, runner_group_id) Gets a specific self-hosted runner group for an organization.
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsGetWorkflow(owner, repo, workflow_id) Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ActionsGetWorkflowRun(owner, repo, run_id, exclude_pull_requests=None) Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ActionsGetWorkflowRunAttempt(owner, repo, run_id, attempt_number, exclude_pull_requests=None) Gets a specific workflow run attempt. Anyone with read access to the repository
can use this endpoint. If the repository is private you must use an access token
with the repo scope. GitHub Apps must have the actions:read permission to
use this endpoint.
ActionsListArtifactsForRepo(owner, repo, per_page=30, page=1) Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ActionsListEnvironmentSecrets(repository_id, environment_name, per_page=30, page=1) Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
ActionsListJobsForWorkflowRun(owner, repo, run_id, filter='latest', per_page=30, page=1) Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
ActionsListJobsForWorkflowRunAttempt(owner, repo, run_id, attempt_number, per_page=30, page=1) Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.
ActionsListOrgSecrets(org, per_page=30, page=1) Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
ActionsListRepoAccessToSelfHostedRunnerGroupInOrg(org, runner_group_id, page=1, per_page=30) The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "GitHub's products."

Lists the repositories with access to a self-hosted runner group configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsListRepoSecrets(owner, repo, per_page=30, page=1) Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.
ActionsListRepoWorkflows(owner, repo, per_page=30, page=1) Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ActionsListRunnerApplicationsForOrg(org) Lists binaries for the runner application that you can download and run.

You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsListRunnerApplicationsForRepo(owner, repo) Lists binaries for the runner application that you can download and run.

You must authenticate using an access token with the repo scope to use this endpoint.
ActionsListSelectedReposForOrgSecret(org, secret_name, page=1, per_page=30) Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
ActionsListSelectedRepositoriesEnabledGithubActionsOrganization(org, per_page=30, page=1) Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
ActionsListSelfHostedRunnerGroupsForOrg(org, per_page=30, page=1) Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsListSelfHostedRunnersForOrg(org, per_page=30, page=1) Lists all self-hosted runners configured in an organization.

You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsListSelfHostedRunnersForRepo(owner, repo, per_page=30, page=1) Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
ActionsListSelfHostedRunnersInGroupForOrg(org, runner_group_id, per_page=30, page=1) Lists self-hosted runners that are in a specific organization group.
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsListWorkflowRunArtifacts(owner, repo, run_id, per_page=30, page=1) Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ActionsListWorkflowRuns(owner, repo, workflow_id, actor=None, branch=None, event=None, status=None, per_page=30, page=1, created=None, exclude_pull_requests=None) List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope.
ActionsListWorkflowRunsForRepo(owner, repo, actor=None, branch=None, event=None, status=None, per_page=30, page=1, created=None, exclude_pull_requests=None) Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ActionsReRunWorkflow(owner, repo, run_id) Re-runs your workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.
ActionsRemoveRepoAccessToSelfHostedRunnerGroupInOrg(org, runner_group_id, repository_id) Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see "Create a self-hosted runner group for an organization."
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsRemoveSelectedRepoFromOrgSecret(org, secret_name, repository_id) Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
ActionsRemoveSelfHostedRunnerFromGroupForOrg(org, runner_group_id, runner_id) Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsReviewPendingDeploymentsForRun(owner, repo, run_id) Approve or reject pending deployments that are waiting on approval by a required reviewer.

Anyone with read access to the repository contents and deployments can use this endpoint.
ActionsSetAllowedActionsOrganization(org) Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
ActionsSetAllowedActionsRepository(owner, repo) Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for a repository."

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
ActionsSetGithubActionsPermissionsOrganization(org) Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
ActionsSetGithubActionsPermissionsRepository(owner, repo) Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.
ActionsSetRepoAccessToSelfHostedRunnerGroupInOrg(org, runner_group_id) Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsSetSelectedReposForOrgSecret(org, secret_name) Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
ActionsSetSelectedRepositoriesEnabledGithubActionsOrganization(org) Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see "Set GitHub Actions permissions for an organization."

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.
ActionsSetSelfHostedRunnersInGroupForOrg(org, runner_group_id) Replaces the list of self-hosted runners that are part of an organization runner group.
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActionsUpdateSelfHostedRunnerGroupForOrg(org, runner_group_id) Updates the name and visibility of a self-hosted runner group in an organization.
You must authenticate using an access token with the admin:org scope to use this endpoint.
ActivityCheckRepoIsStarredByAuthenticatedUser(owner, repo)
ActivityDeleteRepoSubscription(owner, repo) This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.
ActivityDeleteThreadSubscription(thread_id) Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set ignore to true.
ActivityGetFeeds() GitHub Enterprise Server provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:

* Timeline: The GitHub Enterprise Server global public timeline
* User: The public timeline for any user, using URI template
* Current user public: The public timeline for the authenticated user
* Current user: The private timeline for the authenticated user
* Current user actor: The private timeline for activity created by the authenticated user
* Current user organizations: The private timeline for the organizations the authenticated user is a member of.
* Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.

Note: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
ActivityGetRepoSubscription(owner, repo)
ActivityGetThread(thread_id)
ActivityGetThreadSubscriptionForAuthenticatedUser(thread_id) This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.
ActivityListEventsForAuthenticatedUser(username, per_page=30, page=1) If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
ActivityListNotificationsForAuthenticatedUser(all=None, participating=None, since=None, before=None, per_page=30, page=1) List all notifications for the current user, sorted by most recently updated.
ActivityListOrgEventsForAuthenticatedUser(username, org, per_page=30, page=1) This is the user's organization dashboard. You must be authenticated as the user to view this.
ActivityListPublicEvents(per_page=30, page=1) We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.
ActivityListPublicEventsForRepoNetwork(owner, repo, per_page=30, page=1)
ActivityListPublicEventsForUser(username, per_page=30, page=1)
ActivityListPublicOrgEvents(org, per_page=30, page=1)
ActivityListReceivedEventsForUser(username, per_page=30, page=1) These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.
ActivityListReceivedPublicEventsForUser(username, per_page=30, page=1)
ActivityListRepoEvents(owner, repo, per_page=30, page=1)
ActivityListRepoNotificationsForAuthenticatedUser(owner, repo, all=None, participating=None, since=None, before=None, per_page=30, page=1) List all notifications for the current user.
ActivityListReposStarredByAuthenticatedUser(sort='created', direction='desc', per_page=30, page=1) Lists repositories the authenticated user has starred.

You can also find out when stars were created by passing the following custom media type via the Accept header:
ActivityListReposStarredByUser(username, sort='created', direction='desc', per_page=30, page=1) Lists repositories a user has starred.

You can also find out when stars were created by passing the following custom media type via the Accept header:
ActivityListReposWatchedByUser(username, per_page=30, page=1) Lists repositories a user is watching.
ActivityListStargazersForRepo(owner, repo, per_page=30, page=1) Lists the people that have starred the repository.

You can also find out when stars were created by passing the following custom media type via the Accept header:
ActivityListWatchedReposForAuthenticatedUser(per_page=30, page=1) Lists repositories the authenticated user is watching.
ActivityListWatchersForRepo(owner, repo, per_page=30, page=1) Lists the people watching the specified repository.
ActivityMarkNotificationsAsRead() Marks all notifications as "read" removes it from the default view on GitHub Enterprise Server. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.
ActivityMarkRepoNotificationsAsRead(owner, repo) Marks all notifications in a repository as "read" removes them from the default view on GitHub Enterprise Server. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the List repository notifications for the authenticated user endpoint and pass the query parameter all=false.
ActivityMarkThreadAsRead(thread_id)
ActivitySetRepoSubscription(owner, repo) If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.
ActivitySetThreadSubscription(thread_id) If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.
ActivityStarRepoForAuthenticatedUser(owner, repo) Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."
ActivityUnstarRepoForAuthenticatedUser(owner, repo)
AppsAddRepoToInstallationForAuthenticatedUser(installation_id, repository_id) Add a single repository to an installation. The authenticated user must have admin access to the repository.

You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.
AppsCheckAuthorization(client_id, access_token) Deprecation Notice: GitHub Enterprise Server will discontinue OAuth endpoints that contain access_token in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving access_token to the request body. For more information, see the blog post.

OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.
AppsCheckToken(client_id) OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication to use this endpoint, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.
AppsCreateContentAttachment(owner, repo, content_reference_id) Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id and repository full_name of the content reference from the content_reference event to create an attachment.

The app must create a content attachment within six hours of the content reference URL being posted. See "Using content attachments" for details about content attachments.

You must use an installation access token to access this endpoint.
AppsCreateFromManifest(code) Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.
AppsCreateInstallationAccessToken(installation_id) Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.

You must use a JWT to access this endpoint.
AppsDeleteAuthorization(client_id) OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. You must also provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.
Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.
AppsDeleteInstallation(installation_id) Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "Suspend an app installation" endpoint.

You must use a JWT to access this endpoint.
AppsDeleteToken(client_id) OAuth application owners can revoke a single token for an OAuth application. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password.
AppsGetAuthenticated() Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the "List installations for the authenticated app" endpoint.

You must use a JWT to access this endpoint.
AppsGetBySlug(app_slug) Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.
AppsGetInstallation(installation_id) Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (target_type) will be either an organization or a user account, depending which account the repository belongs to.

You must use a JWT to access this endpoint.
AppsGetOrgInstallation(org) Enables an authenticated GitHub App to find the organization's installation information.

You must use a JWT to access this endpoint.
AppsGetRepoInstallation(owner, repo) Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

You must use a JWT to access this endpoint.
AppsGetUserInstallation(username) Enables an authenticated GitHub App to find the user’s installation information.

You must use a JWT to access this endpoint.
AppsGetWebhookConfigForApp() Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App."

You must use a JWT to access this endpoint.
AppsGetWebhookDelivery(delivery_id) Returns a delivery for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.
AppsListInstallationReposForAuthenticatedUser(installation_id, per_page=30, page=1) List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

The access the user has to each repository is included in the hash under the permissions key.
AppsListInstallations(per_page=30, page=1, since=None, outdated=None) You must use a JWT to access this endpoint.

The permissions the installation has are included under the permissions key.
AppsListInstallationsForAuthenticatedUser(per_page=30, page=1) Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You can find the permissions for the installation under the permissions key.
AppsListReposAccessibleToInstallation(per_page=30, page=1) List repositories that an app installation can access.

You must use an installation access token to access this endpoint.
AppsListWebhookDeliveries(per_page=30, cursor=None) Returns a list of webhook deliveries for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.
AppsRedeliverWebhookDelivery(delivery_id) Redeliver a delivery for the webhook configured for a GitHub App.

You must use a JWT to access this endpoint.
AppsRemoveRepoFromInstallationForAuthenticatedUser(installation_id, repository_id) Remove a single repository from an installation. The authenticated user must have admin access to the repository.

You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.
AppsResetAuthorization(client_id, access_token) Deprecation Notice: GitHub Enterprise Server will discontinue OAuth endpoints that contain access_token in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving access_token to the request body. For more information, see the blog post.

OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.
AppsResetToken(client_id) OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.
AppsRevokeAuthorizationForApplication(client_id, access_token) Deprecation Notice: GitHub Enterprise Server will discontinue OAuth endpoints that contain access_token in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving access_token to the request body. For more information, see the blog post.

OAuth application owners can revoke a single token for an OAuth application. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password.
AppsRevokeGrantForApplication(client_id, access_token) Deprecation Notice: GitHub Enterprise Server will discontinue OAuth endpoints that contain access_token in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving access_token to the request body. For more information, see the blog post.

OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. You must also provide a valid token as :access_token and the grant for the token's owner will be deleted.

Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the Applications settings page under "Authorized OAuth Apps" on GitHub Enterprise Server.
AppsRevokeInstallationAccessToken() Revokes the installation token you're using to authenticate as an installation and access this endpoint.

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "Create an installation access token for an app" endpoint.

You must use an installation access token to access this endpoint.
AppsScopeToken(client_id) Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use Basic Authentication when accessing this endpoint, using the OAuth application's client_id and client_secret as the username and password. Invalid tokens will return 404 NOT FOUND.
AppsSuspendInstallation(installation_id) Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.

You must use a JWT to access this endpoint.
AppsUnsuspendInstallation(installation_id) Removes a GitHub App installation suspension.

You must use a JWT to access this endpoint.
AppsUpdateWebhookConfigForApp() Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "Creating a GitHub App."

You must use a JWT to access this endpoint.
ChecksCreate(owner, repo) Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
ChecksCreateSuite(owner, repo) Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "Update repository preferences for check suites". Your GitHub App must have the checks:write permission to create check suites.
ChecksGet(owner, repo, check_run_id) Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
ChecksGetSuite(owner, repo, check_suite_id) Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
ChecksListAnnotations(owner, repo, check_run_id, per_page=30, page=1) Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.
ChecksListForRef(owner, repo, ref, check_name=None, status=None, filter='latest', per_page=30, page=1, app_id=None) Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
ChecksListForSuite(owner, repo, check_suite_id, check_name=None, status=None, filter='latest', per_page=30, page=1) Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.
ChecksListSuitesForRef(owner, repo, ref, app_id=None, check_name=None, per_page=30, page=1) Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.
ChecksRerequestRun(owner, repo, check_run_id) Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, its status is reset to queued and the conclusion is cleared.

To rerequest a check run, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
ChecksRerequestSuite(owner, repo, check_suite_id) Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.
ChecksSetSuitesPreferences(owner, repo) Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.
ChecksUpdate(owner, repo, check_run_id) Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.
CodeScanningDeleteAnalysis(owner, repo, analysis_id, confirm_delete=None) Deletes a specified code scanning analysis from a repository. For
private repositories, you must use an access token with the repo scope. For public repositories,
you must use an access token with public_repo and repo:security_events scopes.
GitHub Apps must have the security_events write permission to use this endpoint.

You can delete one analysis at a time.
To delete a series of analyses, start with the most recent analysis and work backwards.
Conceptually, the process is similar to the undo function in a text editor.

Note: The ability to delete analyses was introduced in GitHub Enterprise Server 3.1.
You can delete analyses that were generated prior to installing this release,
however, if you do so, you will lose information about fixed alerts for all such analyses,
for the relevant code scanning tool.
We recommend that you only delete analyses that were generated with earlier releases
if you don't need the details of fixed alerts from pre-3.1 releases.

When you list the analyses for a repository,
one or more will be identified as deletable in the response:

<br>"deletable": true<br>

An analysis is deletable when it's the most recent in a set of analyses.
Typically, a repository will have multiple sets of analyses
for each enabled code scanning tool,
where a set is determined by a unique combination of analysis values:

* ref
* tool
* analysis_key
* environment

If you attempt to delete an analysis that is not the most recent in a set,
you'll get a 400 response with the message:

<br>Analysis specified is not deletable.<br>

The response from a successful DELETE operation provides you with
two alternative URLs for deleting the next analysis in the set
(see the example default response below).
Use the next_analysis_url URL if you want to avoid accidentally deleting the final analysis
in the set. This is a useful option if you want to preserve at least one analysis
for the specified tool in your repository.
Use the confirm_delete_url URL if you are content to remove all analyses for a tool.
When you delete the last analysis in a set the value of next_analysis_url and confirm_delete_url
in the 200 response is null.

As an example of the deletion process,
let's imagine that you added a workflow that configured a particular code scanning tool
to analyze the code in a repository. This tool has added 15 analyses:
10 on the default branch, and another 5 on a topic branch.
You therefore have two separate sets of analyses for this tool.
You've now decided that you want to remove all of the analyses for the tool.
To do this you must make 15 separate deletion requests.
To start, you must find the deletable analysis for one of the sets,
step through deleting the analyses in that set,
and then repeat the process for the second set.
The procedure therefore consists of a nested loop:

Outer loop:
* List the analyses for the repository, filtered by tool.
* Parse this list to find a deletable analysis. If found:

Inner loop:
* Delete the identified analysis.
* Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
CodeScanningGetAlert(owner, repo, alert_number) Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.

Deprecation notice:
The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by instances_url.
CodeScanningGetAnalysis(owner, repo, analysis_id) Gets a specified code scanning analysis for a repository.
You must use an access token with the security_events scope to use this endpoint.
GitHub Apps must have the security_events read permission to use this endpoint.

The default JSON response contains fields that describe the analysis.
This includes the Git reference and commit SHA to which the analysis relates,
the datetime of the analysis, the name of the code scanning tool,
and the number of alerts.

The rules_count field in the default response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and 0 is returned in this field.

If you use the Accept header application/sarif+json,
the response contains the analysis data that was uploaded.
This is formatted as
SARIF version 2.1.0.
CodeScanningGetSarif(owner, repo, sarif_id) Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "Get a code scanning analysis for a repository." You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.
CodeScanningListAlertInstances(owner, repo, alert_number, page=1, per_page=30, ref=None) Lists all instances of the specified code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.
CodeScanningListAlertsForRepo(owner, repo, tool_name=None, tool_guid=None, page=1, per_page=30, ref=None, state=None) Lists all open code scanning alerts for the default branch (usually main
or master). You must use an access token with the security_events scope to use
this endpoint. GitHub Apps must have the security_events read permission to use
this endpoint.

The response includes a most_recent_instance object.
This provides details of the most recent instance of this alert
for the default branch or for the specified Git reference
(if you used ref in the request).
CodeScanningListRecentAnalyses(owner, repo, tool_name=None, tool_guid=None, page=1, per_page=30, ref=None, sarif_id=None) Lists the details of all code scanning analyses for a repository,
starting with the most recent.
The response is paginated and you can use the page and per_page parameters
to list the analyses you're interested in.
By default 30 analyses are listed per page.

The rules_count field in the response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and 0 is returned in this field.

You must use an access token with the security_events scope to use this endpoint.
GitHub Apps must have the security_events read permission to use this endpoint.

Deprecation notice:
The tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.
CodeScanningUpdateAlert(owner, repo, alert_number) Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.
CodeScanningUploadSarif(owner, repo) Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

There are two places where you can upload code scanning results.
- If you upload to a pull request, for example --ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see "Triaging code scanning alerts in pull requests."
- If you upload to a branch, for example --ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see "Managing code scanning alerts for your repository."

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

```
gzip -c analysis-data.sarif
CodesOfConductGetAllCodesOfConduct()
CodesOfConductGetConductCode(key)
EmojisGet() Lists all the emojis available to use on GitHub Enterprise Server.
EnterpriseAdminAddAuthorizedSshKey() Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
EnterpriseAdminAddOrgAccessToSelfHostedRunnerGroupInEnterprise(enterprise, runner_group_id, org_id) Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see "Create a self-hosted runner group for an enterprise."

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminAddSelfHostedRunnerToGroupForEnterprise(enterprise, runner_group_id, runner_id) Adds a self-hosted runner to a runner group configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
EnterpriseAdminCreateEnterpriseServerLicense() When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.

Note that you need to POST to /setup/api/configure to start the actual configuration process.

When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:

1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.
2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.

Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
EnterpriseAdminCreateGlobalWebhook()
EnterpriseAdminCreateImpersonationOAuthToken(username)
EnterpriseAdminCreateOrg()
EnterpriseAdminCreatePreReceiveEnvironment()
EnterpriseAdminCreatePreReceiveHook()
EnterpriseAdminCreateRegistrationTokenForEnterprise(enterprise) Returns a token that you can pass to the config script. The token expires after one hour.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

#### Example using registration token

Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.

<br>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN<br>
EnterpriseAdminCreateRemoveTokenForEnterprise(enterprise) Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

#### Example using remove token

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this
endpoint.

<br>./config.sh remove --token TOKEN<br>
EnterpriseAdminCreateSelfHostedRunnerGroupForEnterprise(enterprise) Creates a new self-hosted runner group for an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminCreateUser() If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.

The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send "octo_cat" as the login, a user named "octo-cat" will be created.

If the login name or email address is already associated with an account, the server will return a 422 response.
EnterpriseAdminDeleteGlobalWebhook(hook_id, accept='application/vnd.github.superpro-preview+json')
EnterpriseAdminDeleteImpersonationOAuthToken(username)
EnterpriseAdminDeletePersonalAccessToken(token_id) Deletes a personal access token. Returns a 403 - Forbidden status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.
EnterpriseAdminDeletePreReceiveEnvironment(pre_receive_environment_id) If you attempt to delete an environment that cannot be deleted, you will receive a 422 Unprocessable Entity response.

The possible error messages are:

* Cannot modify or delete the default environment
* Cannot delete environment that has hooks
* Cannot delete environment when download is in progress
EnterpriseAdminDeletePreReceiveHook(pre_receive_hook_id)
EnterpriseAdminDeletePublicKey(key_ids)
EnterpriseAdminDeleteSelfHostedRunnerFromEnterprise(enterprise, runner_id) Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminDeleteSelfHostedRunnerGroupFromEnterprise(enterprise, runner_group_id) Deletes a self-hosted runner group for an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminDeleteUser(username) Deleting a user will delete all their repositories, gists, applications, and personal settings. Suspending a user is often a better option.

You can delete any user account except your own.
EnterpriseAdminDemoteSiteAdministrator(username) You can demote any user account except your own.
EnterpriseAdminDisableSelectedOrganizationGithubActionsEnterprise(enterprise, org_id) Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
EnterpriseAdminEnableOrDisableMaintenanceMode() Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
EnterpriseAdminEnableSelectedOrganizationGithubActionsEnterprise(enterprise, org_id) Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
EnterpriseAdminGetAllAuthorizedSshKeys()
EnterpriseAdminGetAllStats()
EnterpriseAdminGetAllowedActionsEnterprise(enterprise) Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
EnterpriseAdminGetAnnouncement() Gets the current message and expiration date of the global announcement banner in your enterprise.
EnterpriseAdminGetAuditLog(enterprise, phrase=None, after=None, before=None, direction='desc', page=1, per_page=30) Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the admin:enterprise scope.
EnterpriseAdminGetCommentStats()
EnterpriseAdminGetConfigurationStatus() This endpoint allows you to check the status of the most recent configuration process:

Note that you may need to wait several seconds after you start a process before you can check its status.

The different statuses are:

EnterpriseAdminGetDownloadStatusForPreReceiveEnvironment(pre_receive_environment_id) In addition to seeing the download status at the "Get a pre-receive environment" endpoint, there is also this separate endpoint for just the download status.
EnterpriseAdminGetGistStats()
EnterpriseAdminGetGithubActionsPermissionsEnterprise(enterprise) Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
EnterpriseAdminGetGlobalWebhook(hook_id)
EnterpriseAdminGetHooksStats() Get hooks statistics
EnterpriseAdminGetIssueStats()
EnterpriseAdminGetLicenseInformation()
EnterpriseAdminGetMaintenanceStatus() Check your installation's maintenance status:
EnterpriseAdminGetMilestoneStats()
EnterpriseAdminGetOrgStats()
EnterpriseAdminGetPagesStats()
EnterpriseAdminGetPreReceiveEnvironment(pre_receive_environment_id)
EnterpriseAdminGetPreReceiveHook(pre_receive_hook_id)
EnterpriseAdminGetPreReceiveHookForOrg(org, pre_receive_hook_id)
EnterpriseAdminGetPreReceiveHookForRepo(owner, repo, pre_receive_hook_id)
EnterpriseAdminGetPullRequestStats()
EnterpriseAdminGetRepoStats() Get repository statistics
EnterpriseAdminGetSelfHostedRunnerForEnterprise(enterprise, runner_id) Gets a specific self-hosted runner configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminGetSelfHostedRunnerGroupForEnterprise(enterprise, runner_group_id) Gets a specific self-hosted runner group for an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminGetSettings()
EnterpriseAdminGetUserStats()
EnterpriseAdminListGlobalWebhooks(accept='application/vnd.github.superpro-preview+json', per_page=30, page=1)
EnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterprise(enterprise, runner_group_id, per_page=30, page=1) Lists the organizations with access to a self-hosted runner group.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminListPersonalAccessTokens(per_page=30, page=1) Lists personal access tokens for all users, including admin users.
EnterpriseAdminListPreReceiveEnvironments(per_page=30, page=1, direction='desc', sort='created')
EnterpriseAdminListPreReceiveHooks(per_page=30, page=1, direction='desc', sort='created')
EnterpriseAdminListPreReceiveHooksForOrg(org, per_page=30, page=1, direction='desc', sort='created') List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.
EnterpriseAdminListPreReceiveHooksForRepo(owner, repo, per_page=30, page=1, direction='desc', sort='created') List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
EnterpriseAdminListPublicKeys(per_page=30, page=1, direction='desc', sort='created', since=None)
EnterpriseAdminListRunnerApplicationsForEnterprise(enterprise) Lists binaries for the runner application that you can download and run.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminListSelectedOrganizationsEnabledGithubActionsEnterprise(enterprise, per_page=30, page=1) Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
EnterpriseAdminListSelfHostedRunnerGroupsForEnterprise(enterprise, per_page=30, page=1) Lists all self-hosted runner groups for an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminListSelfHostedRunnersForEnterprise(enterprise, per_page=30, page=1) Lists all self-hosted runners configured for an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminListSelfHostedRunnersInGroupForEnterprise(enterprise, runner_group_id, per_page=30, page=1) Lists the self-hosted runners that are in a specific enterprise group.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminPingGlobalWebhook(hook_id, accept='application/vnd.github.superpro-preview+json') This will trigger a ping event to be sent to the webhook.
EnterpriseAdminPromoteUserToBeSiteAdministrator(username) Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."
EnterpriseAdminRemoveAnnouncement() Removes the global announcement banner in your enterprise.
EnterpriseAdminRemoveAuthorizedSshKey() Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
EnterpriseAdminRemoveOrgAccessToSelfHostedRunnerGroupInEnterprise(enterprise, runner_group_id, org_id) Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see "Create a self-hosted runner group for an enterprise."

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminRemovePreReceiveHookEnforcementForOrg(org, pre_receive_hook_id) Removes any overrides for this hook at the org level for this org.
EnterpriseAdminRemovePreReceiveHookEnforcementForRepo(owner, repo, pre_receive_hook_id) Deletes any overridden enforcement on this repository for the specified hook.

Responds with effective values inherited from owner and/or global level.
EnterpriseAdminRemoveSelfHostedRunnerFromGroupForEnterprise(enterprise, runner_group_id, runner_id) Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminSetAllowedActionsEnterprise(enterprise) Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
EnterpriseAdminSetAnnouncement() Sets the message and expiration time for the global announcement banner in your enterprise.
EnterpriseAdminSetGithubActionsPermissionsEnterprise(enterprise) Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
EnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterprise(enterprise, runner_group_id) Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminSetSelectedOrganizationsEnabledGithubActionsEnterprise(enterprise) Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see "Set GitHub Actions permissions for an enterprise."

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
EnterpriseAdminSetSelfHostedRunnersInGroupForEnterprise(enterprise, runner_group_id) Replaces the list of self-hosted runners that are part of an enterprise runner group.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminSetSettings() For a list of the available settings, see the Get settings endpoint.

Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
EnterpriseAdminStartConfigurationProcess() This endpoint allows you to start a configuration process at any time for your updated settings to take effect:
EnterpriseAdminStartPreReceiveEnvironmentDownload(pre_receive_environment_id) Triggers a new download of the environment tarball from the environment's image_url. When the download is finished, the newly downloaded tarball will overwrite the existing environment.

If a download cannot be triggered, you will receive a 422 Unprocessable Entity response.

The possible error messages are:

* Cannot modify or delete the default environment
* Can not start a new download when a download is in progress
EnterpriseAdminSuspendUser(username) If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

You can suspend any user account except your own.

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."
EnterpriseAdminSyncLdapMappingForTeam(team_id) Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
EnterpriseAdminSyncLdapMappingForUser(username) Note that this API call does not automatically initiate an LDAP sync. Rather, if a 201 is returned, the sync job is queued successfully, and is performed when the instance is ready.
EnterpriseAdminUnsuspendUser(username) If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.
EnterpriseAdminUpdateGlobalWebhook(hook_id) Parameters that are not provided will be overwritten with the default value or removed if no default exists.
EnterpriseAdminUpdateLdapMappingForTeam(team_id) Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
EnterpriseAdminUpdateLdapMappingForUser(username)
EnterpriseAdminUpdateOrgName(org)
EnterpriseAdminUpdatePreReceiveEnvironment(pre_receive_environment_id) You cannot modify the default environment. If you attempt to modify the default environment, you will receive a 422 Unprocessable Entity response.
EnterpriseAdminUpdatePreReceiveHook(pre_receive_hook_id)
EnterpriseAdminUpdatePreReceiveHookEnforcementForOrg(org, pre_receive_hook_id) For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration
EnterpriseAdminUpdatePreReceiveHookEnforcementForRepo(owner, repo, pre_receive_hook_id) For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
EnterpriseAdminUpdateSelfHostedRunnerGroupForEnterprise(enterprise, runner_group_id) Updates the name and visibility of a self-hosted runner group in an enterprise.

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
EnterpriseAdminUpdateUsernameForUser(username)
EnterpriseAdminUpgradeLicense() This API upgrades your license and also triggers the configuration process.

Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
GistsCheckIsStarred(gist_id)
GistsCreate() Allows you to add a new gist with one or more files.

Note: Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
GistsCreateComment(gist_id)
GistsDelete(gist_id)
GistsDeleteComment(gist_id, comment_id)
GistsFork(gist_id) Note: This was previously /gists/:gist_id/fork.
GistsGet(gist_id)
GistsGetComment(gist_id, comment_id)
GistsGetRevision(gist_id, sha)
GistsList(since=None, per_page=30, page=1) Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
GistsListComments(gist_id, per_page=30, page=1)
GistsListCommits(gist_id, per_page=30, page=1)
GistsListForUser(username, since=None, per_page=30, page=1) Lists public gists for the specified user:
GistsListForks(gist_id, per_page=30, page=1)
GistsListPublic(since=None, per_page=30, page=1) List public gists sorted by most recently updated to least recently updated.

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.
GistsListStarred(since=None, per_page=30, page=1) List the authenticated user's starred gists:
GistsStar(gist_id) Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."
GistsUnstar(gist_id)
GistsUpdate(gist_id) Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
GistsUpdateComment(gist_id, comment_id)
GitCreateBlob(owner, repo)
GitCreateCommit(owner, repo) Creates a new Git commit object.

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:

GitCreateRef(owner, repo) Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
GitCreateTag(owner, repo) Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

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:

GitCreateTree(owner, repo) The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "Create a commit" and "Update a reference."
GitDeleteRef(owner, repo, ref)
GitGetBlob(owner, repo, file_sha) The content in the response will always be Base64 encoded.

Note: This API supports blobs up to 100 megabytes in size.
GitGetCommit(owner, repo, commit_sha) Gets a Git commit object.

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:

GitGetRef(owner, repo, ref) Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "Checking mergeability of pull requests".
GitGetTag(owner, repo, tag_sha) 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:

GitGetTree(owner, repo, tree_sha, recursive=None) Returns a single tree using the SHA1 value for that tree.

If truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
GitListMatchingRefs(owner, repo, ref, per_page=30, page=1) Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "Checking mergeability of pull requests".

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
GitUpdateRef(owner, repo, ref)
GitignoreGetAllTemplates() List all templates available to pass as an option when creating a repository.
GitignoreGetTemplate(name) The API also allows fetching the source of a single template.
Use the raw media type to get the raw contents.
IssuesAddAssignees(owner, repo, issue_number) Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
IssuesAddLabels(owner, repo, issue_number)
IssuesCheckUserCanBeAssigned(owner, repo, assignee) Checks if a user has permission to be assigned to an issue in this repository.

If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

Otherwise a 404 status code is returned.
IssuesCreate(owner, repo) Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
IssuesCreateComment(owner, repo, issue_number) This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
IssuesCreateLabel(owner, repo)
IssuesCreateMilestone(owner, repo)
IssuesDeleteComment(owner, repo, comment_id)
IssuesDeleteLabel(owner, repo, name)
IssuesDeleteMilestone(owner, repo, milestone_number)
IssuesGet(owner, repo, issue_number) The API returns a 301 Moved Permanently status if the issue was
transferred to another repository. If
the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
returns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read
access, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe
to the issues webhook.

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull
request id, use the "List pull requests" endpoint.
IssuesGetComment(owner, repo, comment_id)
IssuesGetEvent(owner, repo, event_id)
IssuesGetLabel(owner, repo, name)
IssuesGetMilestone(owner, repo, milestone_number)
IssuesList(filter='assigned', state='open', labels=None, sort='created', direction='desc', since=None, collab=None, orgs=None, owned=None, pulls=None, per_page=30, page=1) List issues assigned to the authenticated user across all visible repositories including owned repositories, member
repositories, and organization repositories. You can use the filter query parameter to fetch issues that are not
necessarily assigned to you.


Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull
request id, use the "List pull requests" endpoint.
IssuesListAssignees(owner, repo, per_page=30, page=1) Lists the available assignees for issues in a repository.
IssuesListComments(owner, repo, issue_number, since=None, per_page=30, page=1) Issue Comments are ordered by ascending ID.
IssuesListCommentsForRepo(owner, repo, sort='created', direction='desc', since=None, per_page=30, page=1) By default, Issue Comments are ordered by ascending ID.
IssuesListEvents(owner, repo, issue_number, per_page=30, page=1)
IssuesListEventsForRepo(owner, repo, per_page=30, page=1)
IssuesListEventsForTimeline(owner, repo, issue_number, per_page=30, page=1)
IssuesListForAuthenticatedUser(filter='assigned', state='open', labels=None, sort='created', direction='desc', since=None, per_page=30, page=1) List issues across owned and member repositories assigned to the authenticated user.

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull
request id, use the "List pull requests" endpoint.
IssuesListForOrg(org, filter='assigned', state='open', labels=None, sort='created', direction='desc', since=None, per_page=30, page=1) List issues in an organization assigned to the authenticated user.

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull
request id, use the "List pull requests" endpoint.
IssuesListForRepo(owner, repo, milestone=None, state='open', assignee=None, creator=None, mentioned=None, labels=None, sort='created', direction='desc', since=None, per_page=30, page=1) List issues in a repository.

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull
request id, use the "List pull requests" endpoint.
IssuesListLabelsForMilestone(owner, repo, milestone_number, per_page=30, page=1)
IssuesListLabelsForRepo(owner, repo, per_page=30, page=1)
IssuesListLabelsOnIssue(owner, repo, issue_number, per_page=30, page=1)
IssuesListMilestones(owner, repo, state='open', sort='due_on', direction='desc', per_page=30, page=1)
IssuesLock(owner, repo, issue_number) Users with push access can lock an issue or pull request's conversation.

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."
IssuesRemoveAllLabels(owner, repo, issue_number)
IssuesRemoveAssignees(owner, repo, issue_number) Removes one or more assignees from an issue.
IssuesRemoveLabel(owner, repo, issue_number, name) Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
IssuesSetLabels(owner, repo, issue_number) Removes any previous labels and sets the new labels for an issue.
IssuesUnlock(owner, repo, issue_number) Users with push access can unlock an issue's conversation.
IssuesUpdate(owner, repo, issue_number) Issue owners and users with push access can edit an issue.
IssuesUpdateComment(owner, repo, comment_id)
IssuesUpdateLabel(owner, repo, name)
IssuesUpdateMilestone(owner, repo, milestone_number)
LicensesGet(license)
LicensesGetAllCommonlyUsed(featured=None, per_page=30, page=1)
LicensesGetForRepo(owner, repo) This method returns the contents of the repository's license file, if one is detected.

Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
MarkdownRender()
MarkdownRenderRaw() You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
MetaGet()
MetaGetOctocat(s=None) Get the octocat as ASCII art
MetaGetZen() Get a random sentence from the Zen of GitHub
MetaRoot() Get Hypermedia links to resources accessible in GitHub's REST API
OauthAuthorizationsCreateAuthorization() Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.

Creates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.

You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.

Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in the GitHub Help documentation.
OauthAuthorizationsDeleteAuthorization(authorization_id) Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
OauthAuthorizationsDeleteGrant(grant_id) Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
OauthAuthorizationsGetAuthorization(authorization_id) Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
OauthAuthorizationsGetGrant(grant_id) Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
OauthAuthorizationsGetOrCreateAuthorizationForApp(client_id) Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.

Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprint(client_id, fingerprint) Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

Warning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.

This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."
OauthAuthorizationsListAuthorizations(per_page=30, page=1, client_id=None) Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
OauthAuthorizationsListGrants(per_page=30, page=1, client_id=None) Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return ["repo", "user"].
OauthAuthorizationsUpdateAuthorization(authorization_id) Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "Working with two-factor authentication."

You can only send one of these scope keys at a time.
OrgsCheckMembershipForUser(org, username) Check if a user is, publicly or privately, a member of the organization.
OrgsCheckPublicMembershipForUser(org, username)
OrgsConvertMemberToOutsideCollaborator(org, username) When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "Converting an organization member to an outside collaborator".
OrgsCreateWebhook(org) Here's how you can create a hook that posts payloads in JSON format:
OrgsDeleteWebhook(org, hook_id)
OrgsGet(org) To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See "Authenticating with GitHub Apps" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below."
OrgsGetAuditLog(org, phrase=None, after=None, before=None, direction='desc', per_page=30, page=1) Gets the audit log for an organization. For more information, see "Reviewing the audit log for your organization."

To use this endpoint, you must be an organization owner, and you must use an access token with the admin:org scope. GitHub Apps must have the organization_administration read permission to use this endpoint.
OrgsGetMembershipForAuthenticatedUser(org)
OrgsGetMembershipForUser(org, username) In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.
OrgsGetWebhook(org, hook_id) Returns a webhook configured in an organization. To get only the webhook config properties, see "Get a webhook configuration for an organization."
OrgsGetWebhookConfigForOrg(org, hook_id) Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use "Get an organization webhook ."

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:read permission.
OrgsGetWebhookDelivery(org, hook_id, delivery_id) Returns a delivery for a webhook configured in an organization.
OrgsList(since=None, per_page=30) Lists all organizations, in the order that they were created on GitHub Enterprise Server.

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
OrgsListAppInstallations(org, per_page=30, page=1) Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.
OrgsListForAuthenticatedUser(per_page=30, page=1) List organizations for the authenticated user.

OAuth scope requirements

This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with read:org scope, you can publicize your organization membership with user scope, etc.). Therefore, this API requires at least user or read:org scope. OAuth requests with insufficient scope receive a 403 Forbidden response.
OrgsListForUser(username, per_page=30, page=1) List public organization memberships for the specified user.

This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.
OrgsListMembers(org, filter='all', role='all', per_page=30, page=1) List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
OrgsListMembershipsForAuthenticatedUser(state=None, per_page=30, page=1)
OrgsListOutsideCollaborators(org, filter='all', per_page=30, page=1) List all users who are outside collaborators of an organization.
OrgsListPublicMembers(org, per_page=30, page=1) Members of an organization can choose to have their membership publicized or not.
OrgsListWebhookDeliveries(org, hook_id, per_page=30, cursor=None) Returns a list of webhook deliveries for a webhook configured in an organization.
OrgsListWebhooks(org, per_page=30, page=1)
OrgsPingWebhook(org, hook_id) This will trigger a ping event to be sent to the hook.
OrgsRedeliverWebhookDelivery(org, hook_id, delivery_id) Redeliver a delivery for a webhook configured in an organization.
OrgsRemoveMember(org, username) Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.
OrgsRemoveMembershipForUser(org, username) In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.
OrgsRemoveOutsideCollaborator(org, username) Removing a user from this list will remove them from all the organization's repositories.
OrgsRemovePublicMembershipForAuthenticatedUser(org, username)
OrgsSetMembershipForUser(org, username) Only authenticated organization owners can add a member to the organization or update the member's role.

* If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.

* Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.

Rate limits

To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
OrgsSetPublicMembershipForAuthenticatedUser(org, username) The user can publicize their own membership. (A user cannot publicize the membership for another user.)

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."
OrgsUpdate(org) Parameter Deprecation Notice: GitHub Enterprise Server will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.
OrgsUpdateMembershipForAuthenticatedUser(org)
OrgsUpdateWebhook(org, hook_id) Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use "Update a webhook configuration for an organization."
OrgsUpdateWebhookConfigForOrg(org, hook_id) Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use "Update an organization webhook ."

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.
ProjectsAddCollaborator(project_id, username) Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.
ProjectsCreateCard(column_id)
ProjectsCreateColumn(project_id)
ProjectsCreateForAuthenticatedUser()
ProjectsCreateForOrg(org) Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
ProjectsCreateForRepo(owner, repo) Creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
ProjectsDelete(project_id) Deletes a project board. Returns a 404 Not Found status if projects are disabled.
ProjectsDeleteCard(card_id)
ProjectsDeleteColumn(column_id)
ProjectsGet(project_id) Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
ProjectsGetCard(card_id)
ProjectsGetColumn(column_id)
ProjectsGetPermissionForUser(project_id, username) Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
ProjectsListCards(column_id, archived_state='not_archived', per_page=30, page=1)
ProjectsListCollaborators(project_id, affiliation='all', per_page=30, page=1) Lists the collaborators for an organization project. For a project, 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. You must be an organization owner or a project admin to list collaborators.
ProjectsListColumns(project_id, per_page=30, page=1)
ProjectsListForOrg(org, state='open', per_page=30, page=1) Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
ProjectsListForRepo(owner, repo, state='open', per_page=30, page=1) Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
ProjectsListForUser(username, state='open', per_page=30, page=1)
ProjectsMoveCard(card_id)
ProjectsMoveColumn(column_id)
ProjectsRemoveCollaborator(project_id, username) Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.
ProjectsUpdate(project_id) Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.
ProjectsUpdateCard(card_id)
ProjectsUpdateColumn(column_id)
PullsCheckIfMerged(owner, repo, pull_number)
PullsCreate(owner, repo) Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

You can create a new pull request.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
PullsCreateReplyForReviewComment(owner, repo, pull_number, comment_id) Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
PullsCreateReview(owner, repo, pull_number) This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.

Pull request reviews created in the PENDING state do not include the submitted_at property in the response.

Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. The GitHub REST API v3 offers the application/vnd.github.v3.diff media type. To see a pull request diff, add this media type to the Accept header of a call to the single pull request endpoint.

The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.
PullsCreateReviewComment(owner, repo, pull_number)
Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "Create an issue comment." We recommend creating a review comment using line, side, and optionally start_line and start_side if your comment applies to more than one line in the pull request diff.

You can still create a review comment using the position parameter. When you use position, the line, side, start_line, and start_side parameters are not required.

Note: The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
PullsDeletePendingReview(owner, repo, pull_number, review_id)
PullsDeleteReviewComment(owner, repo, comment_id) Deletes a review comment.
PullsDismissReview(owner, repo, pull_number, review_id) Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
PullsGet(owner, repo, pull_number) Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

Lists details of a pull request by providing its number.

When you get, create, or edit a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see "Checking mergeability of pull requests".

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

* If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
* If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
* If rebased, merge_commit_sha represents the commit that the base branch was updated to.

Pass the appropriate media type to fetch diff and patch formats.
PullsGetReview(owner, repo, pull_number, review_id)
PullsGetReviewComment(owner, repo, comment_id) Provides details for a review comment.
PullsList(owner, repo, state='open', head=None, base=None, sort='created', direction='desc', per_page=30, page=1) Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
PullsListCommentsForReview(owner, repo, pull_number, review_id, per_page=30, page=1) List comments for a specific pull request review.
PullsListCommits(owner, repo, pull_number, per_page=30, page=1) Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint.
PullsListFiles(owner, repo, pull_number, per_page=30, page=1) Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.
PullsListRequestedReviewers(owner, repo, pull_number, per_page=30, page=1)
PullsListReviewComments(owner, repo, pull_number, sort='created', direction='desc', since=None, per_page=30, page=1) Lists all review comments for a pull request. By default, review comments are in ascending order by ID.
PullsListReviewCommentsForRepo(owner, repo, sort=None, direction='desc', since=None, per_page=30, page=1) Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.
PullsListReviews(owner, repo, pull_number, per_page=30, page=1) The list of reviews returns in chronological order.
PullsMerge(owner, repo, pull_number) This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
PullsRemoveRequestedReviewers(owner, repo, pull_number)
PullsRequestReviewers(owner, repo, pull_number) This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
PullsSubmitReview(owner, repo, pull_number, review_id)
PullsUpdate(owner, repo, pull_number) Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
PullsUpdateBranch(owner, repo, pull_number) Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
PullsUpdateReview(owner, repo, pull_number, review_id) Update the review summary comment with new text.
PullsUpdateReviewComment(owner, repo, comment_id) Enables you to edit a review comment.
RateLimitGet() Note: Accessing this endpoint does not count against your REST API rate limit.

Note: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.
ReactionsCreateForCommitComment(owner, repo, comment_id) Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
ReactionsCreateForIssue(owner, repo, issue_number) Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
ReactionsCreateForIssueComment(owner, repo, comment_id) Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
ReactionsCreateForPullRequestReviewComment(owner, repo, comment_id) Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
ReactionsCreateForRelease(owner, repo, release_id) Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
ReactionsCreateForTeamDiscussionCommentInOrg(org, team_slug, discussion_number, comment_number) Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
ReactionsCreateForTeamDiscussionCommentLegacy(team_id, discussion_number, comment_number) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "Create reaction for a team discussion comment" endpoint.

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
ReactionsCreateForTeamDiscussionInOrg(org, team_slug, discussion_number) Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.

Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
ReactionsCreateForTeamDiscussionLegacy(team_id, discussion_number) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion endpoint.

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
ReactionsDeleteForCommitComment(owner, repo, comment_id, reaction_id) Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.

Delete a reaction to a commit comment.
ReactionsDeleteForIssue(owner, repo, issue_number, reaction_id) Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

Delete a reaction to an issue.
ReactionsDeleteForIssueComment(owner, repo, comment_id, reaction_id) Note: You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id.

Delete a reaction to an issue comment.
ReactionsDeleteForPullRequestComment(owner, repo, comment_id, reaction_id) Note: You can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

Delete a reaction to a pull request review comment.
ReactionsDeleteForTeamDiscussion(org, team_slug, discussion_number, reaction_id) Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.
ReactionsDeleteForTeamDiscussionComment(org, team_slug, discussion_number, comment_number, reaction_id) Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.

Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.
ReactionsDeleteLegacy(reaction_id) Deprecation Notice: This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this blog post.

OAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.
ReactionsListForCommitComment(owner, repo, comment_id, content=None, per_page=30, page=1) List the reactions to a commit comment.
ReactionsListForIssue(owner, repo, issue_number, content=None, per_page=30, page=1) List the reactions to an issue.
ReactionsListForIssueComment(owner, repo, comment_id, content=None, per_page=30, page=1) List the reactions to an issue comment.
ReactionsListForPullRequestReviewComment(owner, repo, comment_id, content=None, per_page=30, page=1) List the reactions to a pull request review comment.
ReactionsListForTeamDiscussionCommentInOrg(org, team_slug, discussion_number, comment_number, content=None, per_page=30, page=1) List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.
ReactionsListForTeamDiscussionCommentLegacy(team_id, discussion_number, comment_number, content=None, per_page=30, page=1) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment endpoint.

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
ReactionsListForTeamDiscussionInOrg(org, team_slug, discussion_number, content=None, per_page=30, page=1) List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.
ReactionsListForTeamDiscussionLegacy(team_id, discussion_number, content=None, per_page=30, page=1) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion endpoint.

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
ReposAcceptInvitationForAuthenticatedUser(invitation_id)
ReposAddAppAccessRestrictions(owner, repo, 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.

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.

ReposAddCollaborator(owner, repo, username) This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.

For more information on permission levels, see "Repository permission levels for an organization". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

<br>Cannot assign {member} permission of {role name}<br>

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

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.
ReposAddStatusCheckContexts(owner, repo, 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.
ReposAddTeamAccessRestrictions(owner, repo, 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.

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

ReposAddUserAccessRestrictions(owner, repo, 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.

Grants the specified people push access for this branch.

ReposCheckCollaborator(owner, repo, username) 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.
ReposCompareCommits(owner, repo, basehead, page=1, per_page=30) The basehead param is comprised of two parts: base and head. Both 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

To process a response with a large number of commits, you can use (per_page or page) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "Traversing with pagination."

When calling this API without any paging parameters (per_page or page), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.

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:

ReposCreateAutolink(owner, repo) Users with admin access to the repository can create an autolink.
ReposCreateCommitComment(owner, repo, commit_sha) Create a comment for a commit using its :commit_sha.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
ReposCreateCommitSignatureProtection(owner, repo, 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.

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.
ReposCreateCommitStatus(owner, repo, sha) 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.
ReposCreateDeployKey(owner, repo) You can create a read-only deploy key.
ReposCreateDeployment(owner, repo) Deployments offer a few configurable parameters with certain defaults.

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server 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 success
state. 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 success
status for the commit to be deployed, but one or more of the required contexts do not have a state of success.
ReposCreateDeploymentStatus(owner, repo, deployment_id) 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.
ReposCreateDispatchEvent(owner, repo) You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Server 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.
ReposCreateForAuthenticatedUser() 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. Note: For GitHub AE, use repo scope to create an internal repository.
* repo scope to create a private repository.
ReposCreateFork(owner, repo) 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 Enterprise Server Support.
ReposCreateInOrg(org) 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. Note: For GitHub AE, use repo scope to create an internal repository.
* repo scope to create a private repository
ReposCreateOrUpdateEnvironment(owner, repo, environment_name) Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "Environments."

Note: Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see "Environments."

Note: To create or update secrets for an environment, see "Secrets."

You must authenticate using an access token with the repo scope to use this endpoint.
ReposCreateOrUpdateFileContents(owner, repo, path) Creates a new file or replaces an existing file in a repository.
ReposCreatePagesSite(owner, repo) Configures a GitHub Enterprise Server Pages site. For more information, see "About GitHub Pages."
ReposCreateRelease(owner, repo) 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 secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
ReposCreateUsingTemplate(template_owner, template_repo) 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. Note: For GitHub AE, use repo scope to create an internal repository.
* repo scope to create a private repository
ReposCreateWebhook(owner, repo) 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.
ReposDeclineInvitationForAuthenticatedUser(invitation_id)
ReposDelete(owner, repo) 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.
ReposDeleteAccessRestrictions(owner, repo, 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.

Disables the ability to restrict who can push to this branch.
ReposDeleteAdminBranchProtection(owner, repo, 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.

Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
ReposDeleteAnEnvironment(owner, repo, environment_name) You must authenticate using an access token with the repo scope to use this endpoint.
ReposDeleteAutolink(owner, repo, autolink_id) This deletes a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.
ReposDeleteBranchProtection(owner, repo, 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.
ReposDeleteCommitComment(owner, repo, comment_id)
ReposDeleteCommitSignatureProtection(owner, repo, 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.

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.
ReposDeleteDeployKey(owner, repo, key_id) Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
ReposDeleteDeployment(owner, repo, deployment_id) 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."
ReposDeleteFile(owner, repo, path) 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.
ReposDeleteInvitation(owner, repo, invitation_id)
ReposDeletePagesSite(owner, repo)
ReposDeletePullRequestReviewProtection(owner, repo, 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.
ReposDeleteRelease(owner, repo, release_id) Users with push access to the repository can delete a release.
ReposDeleteReleaseAsset(owner, repo, asset_id)
ReposDeleteWebhook(owner, repo, hook_id)
ReposDisableLfsForRepo(owner, repo)
ReposDownloadTarballArchive(owner, repo, ref) Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually
master) 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.
ReposDownloadZipballArchive(owner, repo, ref) Gets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch (usually
master) 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.
ReposEnableLfsForRepo(owner, repo)
ReposGenerateReleaseNotes(owner, repo) Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
ReposGet(owner, repo) 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.
ReposGetAccessRestrictions(owner, repo, 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 who has access to this protected branch.

Note: Users, apps, and teams restrictions are only available for organization-owned repositories.
ReposGetAdminBranchProtection(owner, repo, 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.
ReposGetAllEnvironments(owner, repo) Get all environments for a repository.

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ReposGetAllStatusCheckContexts(owner, repo, 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.
ReposGetAllTopics(owner, repo, page=1, per_page=30)
ReposGetAppsWithAccessToProtectedBranch(owner, repo, 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.
ReposGetAutolink(owner, repo, autolink_id) This returns a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.
ReposGetBranch(owner, repo, branch)
ReposGetBranchProtection(owner, repo, 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.
ReposGetCodeFrequencyStats(owner, repo) Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
ReposGetCollaboratorPermissionLevel(owner, repo, username) Checks the repository permission of a collaborator. The possible repository permissions are admin, write, read, and none.
ReposGetCombinedStatusForRef(owner, repo, ref, per_page=30, page=1) 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.


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
ReposGetCommit(owner, repo, ref, page=1, per_page=30) 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:

ReposGetCommitActivityStats(owner, repo) Returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
ReposGetCommitComment(owner, repo, comment_id)
ReposGetCommitSignatureProtection(owner, repo, 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.

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.
ReposGetContent(owner, repo, path, ref=None) 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 value
should 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.
ReposGetContributorsStats(owner, repo)
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
ReposGetDeployKey(owner, repo, key_id)
ReposGetDeployment(owner, repo, deployment_id)
ReposGetDeploymentStatus(owner, repo, deployment_id, status_id) Users with pull access can view a deployment status for a deployment:
ReposGetEnvironment(owner, repo, environment_name) Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.
ReposGetLatestPagesBuild(owner, repo)
ReposGetLatestRelease(owner, repo) 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.
ReposGetPages(owner, repo)
ReposGetPagesBuild(owner, repo, build_id)
ReposGetParticipationStats(owner, repo) 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.
ReposGetPullRequestReviewProtection(owner, repo, 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.
ReposGetPunchCardStats(owner, repo) 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.
ReposGetReadme(owner, repo, ref=None) Gets the preferred README for a repository.

READMEs support custom media types for retrieving the raw content or rendered HTML.
ReposGetReadmeInDirectory(owner, repo, dir, ref=None) Gets the README from a repository directory.

READMEs support custom media types for retrieving the raw content or rendered HTML.
ReposGetRelease(owner, repo, release_id) Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
ReposGetReleaseAsset(owner, repo, asset_id) 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.
ReposGetReleaseByTag(owner, repo, tag) Get a published release with the specified tag.
ReposGetStatusChecksProtection(owner, repo, 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.
ReposGetTeamsWithAccessToProtectedBranch(owner, repo, 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.
ReposGetUsersWithAccessToProtectedBranch(owner, repo, 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.
ReposGetWebhook(owner, repo, hook_id) Returns a webhook configured in a repository. To get only the webhook config properties, see "Get a webhook configuration for a repository."
ReposGetWebhookConfigForRepo(owner, repo, hook_id) 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.
ReposGetWebhookDelivery(owner, repo, hook_id, delivery_id) Returns a delivery for a webhook configured in a repository.
ReposListAutolinks(owner, repo, page=1) This returns a list of autolinks configured for the given repository.

Information about autolinks are only available to repository administrators.
ReposListBranches(owner, repo, protected=None, per_page=30, page=1)
ReposListBranchesForHeadCommit(owner, repo, commit_sha) 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.
ReposListCollaborators(owner, repo, affiliation='all', per_page=30, page=1) 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.

You must have push access to the repository in order to list collaborators.
ReposListCommentsForCommit(owner, repo, commit_sha, per_page=30, page=1) Use the :commit_sha to specify the commit that will have its comments listed.
ReposListCommitCommentsForRepo(owner, repo, per_page=30, page=1) 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.
ReposListCommitStatusesForRef(owner, repo, ref, per_page=30, page=1) Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

This resource is also available via a legacy route: GET /repos/:owner/:repo/statuses/:ref.
ReposListCommits(owner, repo, sha=None, path=None, author=None, since=None, until=None, per_page=30, page=1) 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:

ReposListContributors(owner, repo, anon=None, per_page=30, page=1) Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.

GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
ReposListDeployKeys(owner, repo, per_page=30, page=1)
ReposListDeploymentStatuses(owner, repo, deployment_id, per_page=30, page=1) Users with pull access can view deployment statuses for a deployment:
ReposListDeployments(owner, repo, sha=None, ref=None, task=None, environment=None, per_page=30, page=1) Simple filtering of deployments is available via query parameters:
ReposListForAuthenticatedUser(visibility='all', affiliation=None, type=None, sort='created', direction='desc', per_page=30, page=1, since=None, before=None) Lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
ReposListForOrg(org, type=None, sort='created', direction='desc', per_page=30, page=1) Lists repositories for the specified organization.
ReposListForUser(username, type='owner', sort='created', direction='desc', per_page=30, page=1) Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.
ReposListForks(owner, repo, sort='newest', per_page=30, page=1)
ReposListInvitations(owner, repo, per_page=30, page=1) When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
ReposListInvitationsForAuthenticatedUser(per_page=30, page=1) When authenticating as a user, this endpoint will list all currently open repository invitations for that user.
ReposListLanguages(owner, repo) Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
ReposListPagesBuilds(owner, repo, per_page=30, page=1)
ReposListPublic(since=None, visibility='public') Lists all public repositories in the order that they were created.

Note:
- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
- Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
ReposListPullRequestsAssociatedWithCommit(owner, repo, commit_sha, per_page=30, page=1) Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the List pull requests endpoint.
ReposListReleaseAssets(owner, repo, release_id, per_page=30, page=1)
ReposListReleases(owner, repo, per_page=30, page=1) This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.
ReposListTags(owner, repo, per_page=30, page=1)
ReposListTeams(owner, repo, per_page=30, page=1)
ReposListWebhookDeliveries(owner, repo, hook_id, per_page=30, cursor=None) Returns a list of webhook deliveries for a webhook configured in a repository.
ReposListWebhooks(owner, repo, per_page=30, page=1)
ReposMerge(owner, repo)
ReposMergeUpstream(owner, repo) Sync a branch of a forked repository to keep it up-to-date with the upstream repository.
ReposPingWebhook(owner, repo, hook_id) This will trigger a ping event to be sent to the hook.
ReposRedeliverWebhookDelivery(owner, repo, hook_id, delivery_id) Redeliver a webhook delivery for a webhook configured in a repository.
ReposRemoveAppAccessRestrictions(owner, repo, 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.

Removes the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

ReposRemoveCollaborator(owner, repo, username)
ReposRemoveStatusCheckContexts(owner, repo, 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.
ReposRemoveStatusCheckProtection(owner, repo, 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.
ReposRemoveTeamAccessRestrictions(owner, repo, 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.

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

ReposRemoveUserAccessRestrictions(owner, repo, 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.

Removes the ability of a user to push to this branch.

ReposRenameBranch(owner, repo, branch) Renames a branch in a repository.

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "Renaming a branch".

The permissions required to use this endpoint depends on whether you are renaming the default branch.

To rename a non-default branch:

* Users must have push access.
* GitHub Apps must have the contents:write repository permission.

To rename the default branch:

* Users must have admin or owner permissions.
* GitHub Apps must have the administration:write repository permission.
ReposReplaceAllTopics(owner, repo)
ReposRequestPagesBuild(owner, repo) You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
ReposSetAdminBranchProtection(owner, repo, 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.

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
ReposSetAppAccessRestrictions(owner, repo, 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.

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

ReposSetStatusCheckContexts(owner, repo, 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.
ReposSetTeamAccessRestrictions(owner, repo, 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.

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

ReposSetUserAccessRestrictions(owner, repo, 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.

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

ReposTestPushWebhook(owner, repo, hook_id) This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.

Note: Previously /repos/:owner/:repo/hooks/:hook_id/test
ReposTransfer(owner, repo) A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
ReposUpdate(owner, repo) Note: To edit a repository's topics, use the Replace all repository topics endpoint.
ReposUpdateBranchProtection(owner, repo, 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.

Protecting a branch requires admin or owner permissions to the repository.

Note: Passing new arrays of users and teams replaces their previous values.

Note: The list of users, apps, and teams in total is limited to 100 items.
ReposUpdateCommitComment(owner, repo, comment_id)
ReposUpdateInformationAboutPagesSite(owner, repo) Updates information for a GitHub Enterprise Server Pages site. For more information, see "About GitHub Pages.
ReposUpdateInvitation(owner, repo, invitation_id)
ReposUpdatePullRequestReviewProtection(owner, repo, 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.

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

Note: Passing new arrays of users and teams replaces their previous values.
ReposUpdateRelease(owner, repo, release_id) Users with push access to the repository can edit a release.
ReposUpdateReleaseAsset(owner, repo, asset_id) Users with push access to the repository can edit a release asset.
ReposUpdateStatusCheckProtection(owner, repo, 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.

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
ReposUpdateWebhook(owner, repo, hook_id) Updates a webhook configured in a repository. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use "Update a webhook configuration for a repository."
ReposUpdateWebhookConfigForRepo(owner, repo, hook_id) Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use "Update a repository webhook."

Access tokens must have the write:repo_hook or repo scope, and GitHub Apps must have the repository_hooks:write permission.
ReposUploadReleaseAsset(owner, repo, release_id, name, label) This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in
the response of the Create a release endpoint to upload a release asset.

You need to use an HTTP client which supports SNI to make calls to this endpoint.

Most libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:

application/zip

GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,
you'll still need to pass your authentication to be able to upload an asset.

When an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.

Notes:
* GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "List assets for a release"
endpoint lists the renamed filenames. For more information and help, contact GitHub Enterprise Server Support.
* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
SearchCode(q, sort=None, direction='desc', per_page=30, page=1) Searches for query terms inside of a file. This method returns up to 100 results per page.

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

q=addClass+in:file+language:js+repo:jquery/jquery

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

#### Considerations for code search

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

* Only the default branch is considered. In most cases, this will be the master branch.
* Only files smaller than 384 KB are searchable.
* You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing<br>language:go is.
SearchCommits(q, sort=None, direction='desc', per_page=30, page=1) Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.

When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match
metadata
.

For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:

q=repo:octocat/Spoon-Knife+css
SearchIssuesAndPullRequests(q, sort=None, direction='desc', per_page=30, page=1) Find issues by state and keyword. This method returns up to 100 results per page.

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted
search results, see Text match metadata.

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

q=windows+label:bug+language:python+state:open&sort=created&order=asc

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

Note: For user-to-server GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see "Searching only issues or pull requests."
SearchLabels(repository_id, q, sort='created', direction='desc', per_page=30, page=1) Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

q=bug+defect+enhancement&repository_id=64778136

The labels that best match the query appear first in the search results.
SearchRepos(q, sort=None, direction='desc', per_page=30, page=1) Find repositories via various criteria. This method returns up to 100 results per page.

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

q=tetris+language:assembly&sort=stars&order=desc

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
SearchTopics(q, per_page=30, page=1) Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See "Searching topics" for a detailed list of qualifiers.

When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

q=ruby+is:featured

This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
SearchUsers(q, sort=None, direction='desc', per_page=30, page=1) Find users via various criteria. This method returns up to 100 results per page.

When searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you're looking for a list of popular users, you might try this query:

q=tom+repos:%3E42+followers:%3E1000

This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.
SecretScanningGetAlert(owner, repo, alert_number) Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
SecretScanningListAlertsForOrg(org, state=None, secret_type=None, resolution=None, page=1, per_page=30) Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
SecretScanningListAlertsForRepo(owner, repo, state=None, secret_type=None, resolution=None, page=1, per_page=30) Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
SecretScanningListLocationsForAlert(owner, repo, alert_number, page=1, per_page=30) Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
SecretScanningUpdateAlert(owner, repo, alert_number) Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.

GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.
TeamsAddMemberLegacy(team_id, username) The "Add team member" endpoint (described below) is deprecated.

We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub Enterprise Server."

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."
TeamsAddOrUpdateMembershipForUserInOrg(org, team_slug, username) Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub Enterprise Server."

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
TeamsAddOrUpdateMembershipForUserLegacy(team_id, username) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub Enterprise Server."

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
TeamsAddOrUpdateProjectPermissionsInOrg(org, team_slug, project_id) Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
TeamsAddOrUpdateProjectPermissionsLegacy(team_id, project_id) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.

Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
TeamsAddOrUpdateRepoPermissionsInOrg(org, team_slug, owner, repo) To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the 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."

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

For more information about the permission levels, see "Repository permission levels for an organization".
TeamsAddOrUpdateRepoPermissionsLegacy(team_id, owner, repo) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "Add or update team repository permissions" endpoint.

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the 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."
TeamsCheckPermissionsForProjectInOrg(org, team_slug, project_id) Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
TeamsCheckPermissionsForProjectLegacy(team_id, project_id) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
TeamsCheckPermissionsForRepoInOrg(org, team_slug, owner, repo) Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.

If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
TeamsCheckPermissionsForRepoLegacy(team_id, owner, repo) Note: Repositories inherited through a parent team will also be checked.

Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repository endpoint.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
TeamsCreate(org) To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "Setting team creation permissions."

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see "About teams".
TeamsCreateDiscussionCommentInOrg(org, team_slug, discussion_number) Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

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

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
TeamsCreateDiscussionCommentLegacy(team_id, discussion_number) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
TeamsCreateDiscussionInOrg(org, team_slug) Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

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

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
TeamsCreateDiscussionLegacy(team_id) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
TeamsDeleteDiscussionCommentInOrg(org, team_slug, discussion_number, comment_number) Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
TeamsDeleteDiscussionCommentLegacy(team_id, discussion_number, comment_number) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.

Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
TeamsDeleteDiscussionInOrg(org, team_slug, discussion_number) Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
TeamsDeleteDiscussionLegacy(team_id, discussion_number) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.

Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
TeamsDeleteInOrg(org, team_slug) To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.
TeamsDeleteLegacy(team_id) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.

To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.
TeamsGetByName(org, team_slug) Gets a team using the team's slug. GitHub Enterprise Server generates the slug from the team name.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.
TeamsGetDiscussionCommentInOrg(org, team_slug, discussion_number, comment_number) Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
TeamsGetDiscussionCommentLegacy(team_id, discussion_number, comment_number) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.

Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
TeamsGetDiscussionInOrg(org, team_slug, discussion_number) Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
TeamsGetDiscussionLegacy(team_id, discussion_number) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.

Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
TeamsGetLegacy(team_id) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
TeamsGetMemberLegacy(team_id, username) The "Get team member" endpoint (described below) is deprecated.

We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.

To list members in a team, the team must be visible to the authenticated user.
TeamsGetMembershipForUserInOrg(org, team_slug, username) Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.

Note:
The response contains the state of the membership and the member's role.

The role for organization owners is set to maintainer. For more information about maintainer roles, see see Create a team.
TeamsGetMembershipForUserLegacy(team_id, username) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.

Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

Note:
The response contains the state of the membership and the member's role.

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.
TeamsList(org, per_page=30, page=1) Lists all teams in an organization that are visible to the authenticated user.
TeamsListChildInOrg(org, team_slug, per_page=30, page=1) Lists the child teams of the team specified by {team_slug}.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.
TeamsListChildLegacy(team_id, per_page=30, page=1) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams endpoint.
TeamsListDiscussionCommentsInOrg(org, team_slug, discussion_number, direction='desc', per_page=30, page=1) List all comments on a team discussion. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.
TeamsListDiscussionCommentsLegacy(team_id, discussion_number, direction='desc', per_page=30, page=1) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.

List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
TeamsListDiscussionsInOrg(org, team_slug, direction='desc', per_page=30, page=1, pinned=None) List all discussions on a team's page. OAuth access tokens require the read:discussion scope.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
TeamsListDiscussionsLegacy(team_id, direction='desc', per_page=30, page=1) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions endpoint.

List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
TeamsListForAuthenticatedUser(per_page=30, page=1) List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user, repo, or read:org scope when authenticating via OAuth.
TeamsListMembersInOrg(org, team_slug, role='all', per_page=30, page=1) Team members will include the members of child teams.

To list members in a team, the team must be visible to the authenticated user.
TeamsListMembersLegacy(team_id, role='all', per_page=30, page=1) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members endpoint.

Team members will include the members of child teams.
TeamsListProjectsInOrg(org, team_slug, per_page=30, page=1) Lists the organization projects for a team.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
TeamsListProjectsLegacy(team_id, per_page=30, page=1) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.

Lists the organization projects for a team.
TeamsListReposInOrg(org, team_slug, per_page=30, page=1) Lists a team's repositories visible to the authenticated user.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.
TeamsListReposLegacy(team_id, per_page=30, page=1) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
TeamsRemoveMemberLegacy(team_id, username) The "Remove team member" endpoint (described below) is deprecated.

We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub Enterprise Server."
TeamsRemoveMembershipForUserInOrg(org, team_slug, username) Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub Enterprise Server."

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
TeamsRemoveMembershipForUserLegacy(team_id, username) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

Note: When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "Synchronizing teams between your identity provider and GitHub Enterprise Server."
TeamsRemoveProjectInOrg(org, team_slug, project_id) Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.
TeamsRemoveProjectLegacy(team_id, project_id) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.

Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. Note: This endpoint removes the project from the team, but does not delete it.
TeamsRemoveRepoInOrg(org, team_slug, owner, repo) If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.
TeamsRemoveRepoLegacy(team_id, owner, repo) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
TeamsUpdateDiscussionCommentInOrg(org, team_slug, discussion_number, comment_number) Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.
TeamsUpdateDiscussionCommentLegacy(team_id, discussion_number, comment_number) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.

Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
TeamsUpdateDiscussionInOrg(org, team_slug, discussion_number) Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.
TeamsUpdateDiscussionLegacy(team_id, discussion_number) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.

Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.
TeamsUpdateInOrg(org, team_slug) To edit a team, the authenticated user must either be an organization owner or a team maintainer.

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.
TeamsUpdateLegacy(team_id) Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

Note: With nested teams, the privacy for parent teams cannot be secret.
UsersAddEmailForAuthenticatedUser() This endpoint is accessible with the user scope.
UsersCheckFollowingForUser(username, target_user)
UsersCheckPersonIsFollowedByAuthenticated(username)
UsersCreateGpgKeyForAuthenticatedUser() Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:gpg_key scope.
UsersCreatePublicSshKeyForAuthenticatedUser() Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:public_key scope.
UsersDeleteEmailForAuthenticatedUser() This endpoint is accessible with the user scope.
UsersDeleteGpgKeyForAuthenticatedUser(gpg_key_id) Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:gpg_key scope.
UsersDeletePublicSshKeyForAuthenticatedUser(key_id) Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.
UsersFollow(username) Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
UsersGetAuthenticated() If the authenticated user is authenticated through basic authentication or OAuth with the user scope, then the response lists public and private profile information.

If the authenticated user is authenticated through OAuth without the user scope, then the response lists only public profile information.
UsersGetByUsername(username) Provides publicly available information about someone with a GitHub account.

GitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See "Identifying and authorizing users for GitHub Apps" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below"

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "Emails API".
UsersGetContextForUser(username, subject_type=None, subject_id=None) Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

The subject_type and subject_id parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

shell<br> curl -u username:token<br> https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192<br>
UsersGetGpgKeyForAuthenticatedUser(gpg_key_id) View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.
UsersGetPublicSshKeyForAuthenticatedUser(key_id) View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.
UsersList(since=None, per_page=30) Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
UsersListEmailsForAuthenticatedUser(per_page=30, page=1) Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.
UsersListFollowedByAuthenticatedUser(per_page=30, page=1) Lists the people who the authenticated user follows.
UsersListFollowersForAuthenticatedUser(per_page=30, page=1) Lists the people following the authenticated user.
UsersListFollowersForUser(username, per_page=30, page=1) Lists the people following the specified user.
UsersListFollowingForUser(username, per_page=30, page=1) Lists the people who the specified user follows.
UsersListGpgKeysForAuthenticatedUser(per_page=30, page=1) Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.
UsersListGpgKeysForUser(username, per_page=30, page=1) Lists the GPG keys for a user. This information is accessible by anyone.
UsersListPublicEmailsForAuthenticatedUser(per_page=30, page=1) Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.
UsersListPublicKeysForUser(username, per_page=30, page=1) Lists the verified public SSH keys for a user. This is accessible by anyone.
UsersListPublicSshKeysForAuthenticatedUser(per_page=30, page=1) Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.
UsersUnfollow(username) Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
UsersUpdateAuthenticated() Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.