Skip to main content

GitHub

Manage repositories, issues, pull requests, and more on GitHub.

GitHub Logo

Authentication​

This connector uses OAuth 2.0 authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 1016 actions:

ActionPurposeParameters
getGet Hypermedia links to resources accessible in GitHub's REST APINo parameters
get_admin_hooksList global webhooksper_page (integer)
page (integer)
post_admin_hooksCreate a global webhookdata: {
. name (string)
. config (object)
. events (array)
. active (boolean)
} (object) required
get_admin_hooks_by_hook_idGet a global webhookhook_id (integer)
patch_admin_hooks_by_hook_idParameters that are not provided will be overwritten with the default value or removed if no default exists.hook_id (integer)
data: {
. config (object)
. events (array)
. active (boolean)
} (object) required
delete_admin_hooks_by_hook_idDelete a global webhookhook_id (integer)
post_admin_hooks_by_hook_id_pingsThis will trigger a ping eventhttps://docs.github.com/enterprise-server@3.18/webhooks/ ping-event to be sent to the webhook.hook_id (integer)
get_admin_keysList public keysper_page (integer)
page (integer)
direction (string)
sort (string)
since (string)
delete_admin_keys_by_key_idsDelete a public keykey_ids (string)
patch_admin_ldap_teams_by_team_id_mappingUpdates the distinguished namehttps://www.ldap.com/ldap-dns-and-rdns DN of the LDAP entry to map to a team. LDAP synchronizationhttps://docs.github.com/enterprise-server@3.18/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap enabling-ldap-sync must be enabled to map LDAP entries to a team. Use the Create a teamhttps://docs.github.com/enterprise-server@3.18/rest/teams/teams/ create-a-team endpoint to create a team with LDAP mapping.team_id (integer)
data: {
. ldap_dn (string)
} (object) required
post_admin_ldap_teams_by_team_id_syncNote 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.team_id (integer)
patch_admin_ldap_users_by_username_mappingUpdate LDAP mapping for a userusername (string)
data: {
. ldap_dn (string)
} (object) required
post_admin_ldap_users_by_username_syncNote 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.username (string)
post_admin_organizationsCreate an organizationdata: {
. login (string)
. admin (string)
. profile_name (string)
} (object) required
patch_admin_organizations_by_orgUpdate an organization nameorg (string)
data: {
. login (string)
} (object) required
get_admin_pre_receive_environmentsList pre-receive environmentsper_page (integer)
page (integer)
direction (string)
sort (string)
post_admin_pre_receive_environmentsCreate a pre-receive environmentdata: {
. name (string)
. image_url (string)
} (object) required
get_admin_pre_receive_environments_by_pre_receive_environment_idGet a pre-receive environmentpre_receive_environment_id (integer)
patch_admin_pre_receive_environments_by_pre_receive_environment_idYou cannot modify the default environment. If you attempt to modify the default environment, you will receive a 422 Unprocessable Entity response.pre_receive_environment_id (integer)
data: {
. name (string)
. image_url (string)
} (object) required
delete_admin_pre_receive_environments_by_pre_receive_environment_idIf 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 progresspre_receive_environment_id (integer)
post_admin_pre_receive_environments_by_pre_receive_environment_id_downloadsTriggers 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 progresspre_receive_environment_id (integer)
get_admin_pre_receive_environments_by_pre_receive_environment_id_downloads_latestIn addition to seeing the download status at the 'Get a pre-receive environment get-a-pre-receive-environment' endpoint, there is also this separate endpoint for just the download status.pre_receive_environment_id (integer)
get_admin_pre_receive_hooksList pre-receive hooksper_page (integer)
page (integer)
direction (string)
sort (string)
post_admin_pre_receive_hooksCreate a pre-receive hookdata: {
. name (string)
. script (string)
. script_repository (object)
. environment (object)
. enforcement (string)
. allow_downstream_configuration (boolean)
} (object) required
get_admin_pre_receive_hooks_by_pre_receive_hook_idGet a pre-receive hookpre_receive_hook_id (integer)
patch_admin_pre_receive_hooks_by_pre_receive_hook_idUpdate a pre-receive hookpre_receive_hook_id (integer)
data: {
. name (string)
. script (string)
. script_repository (object)
. environment (object)
. enforcement (string)
. allow_downstream_configuration (boolean)
} (object) required
delete_admin_pre_receive_hooks_by_pre_receive_hook_idDelete a pre-receive hookpre_receive_hook_id (integer)
get_admin_tokensLists personal access tokens for all users, including admin users.per_page (integer)
page (integer)
delete_admin_tokens_by_token_idDeletes 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.token_id (integer)
post_admin_usersIf 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 mappinghttps://docs.github.com/enterprise-server@3.18/rest/enterprise-admin/ldap update-ldap-mapping-for-a-user 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. Ifdata: {
. login (string)
. email (string)
. suspended (boolean)
} (object) required
patch_admin_users_by_usernameUpdate the username for a userusername (string)
data: {
. login (string)
} (object) required
delete_admin_users_by_usernameDeleting a user will delete all their repositories, gists, applications, and personal settings. Suspending a userhttps://docs.github.com/enterprise-server@3.18/rest/enterprise-admin/users suspend-a-user is often a better option. You can delete any user account except your own.username (string)
post_admin_users_by_username_authorizationsCreate an impersonation OAuth tokenusername (string)
data: {
. scopes (array)
} (object) required
delete_admin_users_by_username_authorizationsDelete an impersonation OAuth tokenusername (string)
get_advisoriesLists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see 'About the Gitghsa_id (string)
type (string)
cve_id (string)
ecosystem (string)
severity (string)
cwes (undefined)
is_withdrawn (boolean)
affects (undefined)
published (string)
updated (string)
modified (string)
epss_percentage (string)
epss_percentile (string)
before (string)
after (string)
direction (string)
per_page (integer)
sort (string)
get_advisories_by_ghsa_idGets a global security advisory using its GitHub Security Advisory GHSA identifier.ghsa_id (string)
get_appReturns 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 apphttps://docs.github.com/enterprise-server@3.18/rest/apps/apps list-installations-for-the-authenticated-app' endpoint. You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-aNo parameters
post_app_manifests_by_code_conversionsUse this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flowhttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/creating-github-apps-from-a-manifest/. 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.code (string)
get_app_hook_configReturns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see 'Creating a GitHub App/developers/apps/creating-a-github-app.' You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.No parameters
patch_app_hook_configUpdates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see 'Creating a GitHub App/developers/apps/creating-a-github-app.' You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.data: {
. url (string)
. content_type (string)
. secret (string)
. insecure_ssl
} (object) required
get_app_hook_deliveriesReturns a list of webhook deliveries for the webhook configured for a GitHub App. You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.per_page (integer)
cursor (string)
get_app_hook_deliveries_by_delivery_idReturns a delivery for the webhook configured for a GitHub App. You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.delivery_id (integer)
post_app_hook_deliveries_by_delivery_id_attemptsRedeliver a delivery for the webhook configured for a GitHub App. You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.delivery_id (integer)
get_app_installation_requestsLists all the pending installation requests for the authenticated GitHub App.per_page (integer)
page (integer)
get_app_installationsThe permissions the installation has are included under the permissions key. You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.per_page (integer)
page (integer)
since (string)
outdated (string)
get_app_installations_by_installation_idEnables an authenticated GitHub App to find an installation's information using the installation id. You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.installation_id (integer)
delete_app_installations_by_installation_idUninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the 'Suspend an app installationhttps://docs.github.com/enterprise-server@3.18/rest/apps/apps suspend-an-app-installation' endpoint. You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.installation_id (integer)
post_app_installations_by_installation_id_access_tokensCreates 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. Optionally, you can use the repositories or reposinstallation_id (integer)
data: {
. repositories (array)
. repository_ids (array)
. permissions (object)
} (object) required
put_app_installations_by_installation_id_suspendedSuspends a GitHub App on a user, organization, or enterprise 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 JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.installation_id (integer)
delete_app_installations_by_installation_id_suspendedRemoves a GitHub App installation suspension. You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.installation_id (integer)
get_applications_grants!WARNING Closing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations APIhttps://docs.github.com/enterprise-server@3.18/rest/oauth-authorizations/oauth-authorizations/, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flowhttps://docs.github.com/enterprise-server@3.18/developers/apps/authorizing-oauth-apps web-application-flow. The OAuth Authorizations APIhttps://docs.githuper_page (integer)
page (integer)
client_id (string)
get_applications_grants_by_grant_id!WARNING Closing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations APIhttps://docs.github.com/enterprise-server@3.18/rest/oauth-authorizations/oauth-authorizations, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flowhttps://docs.github.com/enterprise-server@3.18/apps/building-oauth-apps/authorizing-oauth-apps/ web-application-flow. The OAuth Authorizations APIhttps://dgrant_id (integer)
delete_applications_grants_by_grant_id!WARNING Closing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations APIhttps://docs.github.com/enterprise-server@3.18/rest/oauth-authorizations/oauth-authorizations/, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flowhttps://docs.github.com/enterprise-server@3.18/developers/apps/authorizing-oauth-apps web-application-flow. The OAuth Authorizations APIhttps://docs.githugrant_id (integer)
delete_applications_by_client_id_grantOAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted. Deleting an 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 GitHubhttps:/client_id (string)
data: {
. access_token (string)
} (object) required
post_applications_by_client_id_tokenOAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return 404 NOT FOUND.client_id (string)
data: {
. access_token (string)
} (object) required
patch_applications_by_client_id_tokenOAuth applications and GitHub applications with OAuth authorizations 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. Invalid tokens will return 404 NOT FOUND.client_id (string)
data: {
. access_token (string)
} (object) required
delete_applications_by_client_id_tokenOAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.client_id (string)
data: {
. access_token (string)
} (object) required
post_applications_by_client_id_token_scopedUse a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. Invalid tokens will return 404 NOT FOUND.client_id (string)
data: {
. access_token (string)
. target (string)
. target_id (integer)
. repositories (array)
. repository_ids (array)
. permissions (object)
} (object) required
get_apps_by_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.app_slug (string)
get_authorizations!WARNING Closing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations APIhttps://docs.github.com/enterprise-server@3.18/rest/oauth-authorizations/oauth-authorizations, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flowhttps://docs.github.com/enterprise-server@3.18/apps/building-oauth-apps/authorizing-oauth-apps/ web-application-flow. The OAuth Authorizations APIhttps://dper_page (integer)
page (integer)
client_id (string)
post_authorizations!WARNING Closing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations APIhttps://docs.github.com/enterprise-server@3.18/rest/oauth-authorizations/oauth-authorizations, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flowhttps://docs.github.com/enterprise-server@3.18/developers/apps/authorizing-oauth-apps web-application-flow. The OAuth Authorizations APIhttps://docs.githubdata: {
. scopes (array)
. note (string)
. note_url (string)
. client_id (string)
. client_secret (string)
. fingerprint (string)
} (object) required
put_authorizations_clients_by_client_id!WARNING Closing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations APIhttps://docs.github.com/enterprise-server@3.18/rest/oauth-authorizations/oauth-authorizations/, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flowhttps://docs.github.com/enterprise-server@3.18/developers/apps/authorizing-oauth-apps web-application-flow. The OAuth Authorizations APIhttps://docs.githuclient_id (string)
data: {
. client_secret (string)
. scopes (array)
. note (string)
. note_url (string)
. fingerprint (string)
} (object) required
put_authorizations_clients_by_client_id_by_fingerprint!WARNING Closing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations APIhttps://docs.github.com/enterprise-server@3.18/rest/oauth-authorizations/oauth-authorizations/, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flowhttps://docs.github.com/enterprise-server@3.18/developers/apps/authorizing-oauth-apps web-application-flow. The OAuth Authorizations APIhttps://docs.githuclient_id (string)
fingerprint (string)
data: {
. client_secret (string)
. scopes (array)
. note (string)
. note_url (string)
} (object) required
get_authorizations_by_authorization_id!WARNING Closing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations APIhttps://docs.github.com/enterprise-server@3.18/rest/oauth-authorizations/oauth-authorizations, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flowhttps://docs.github.com/enterprise-server@3.18/apps/building-oauth-apps/authorizing-oauth-apps/ web-application-flow. The OAuth Authorizations APIhttps://dauthorization_id (integer)
patch_authorizations_by_authorization_id!WARNING Closing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations APIhttps://docs.github.com/enterprise-server@3.18/rest/oauth-authorizations/oauth-authorizations/, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flowhttps://docs.github.com/enterprise-server@3.18/developers/apps/authorizing-oauth-apps web-application-flow. The OAuth Authorizations APIhttps://docs.githuauthorization_id (integer)
data: {
. scopes (array)
. add_scopes (array)
. remove_scopes (array)
. note (string)
. note_url (string)
. fingerprint (string)
} (object) required
delete_authorizations_by_authorization_id!WARNING Closing down notice: GitHub Enterprise Server will discontinue the OAuth Authorizations APIhttps://docs.github.com/enterprise-server@3.18/rest/oauth-authorizations/oauth-authorizations, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flowhttps://docs.github.com/enterprise-server@3.18/apps/building-oauth-apps/authorizing-oauth-apps/ web-application-flow. The OAuth Authorizations APIhttps://dauthorization_id (integer)
get_codes_of_conductReturns array of all GitHub's codes of conduct.No parameters
get_codes_of_conduct_by_keyReturns information about the specified GitHub code of conduct.key (string)
post_credentials_revokeSubmit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. Credential owners will be notified of the revocation. This endpoint currently accepts the following credential types: - classic personal access tokens - fine-grained personal access tokens To prevent abuse, this API is limited to 60 authenticated requests per hour and a max of 1000 tokens per API request.data: {
. credentials (array)
} (object) required
get_emojisLists all the emojis available to use on GitHub Enterprise Server.No parameters
get_enterprise_announcementGets the current message and expiration date of the global announcement banner in your enterprise.No parameters
patch_enterprise_announcementSets the message and expiration time for the global announcement banner in your enterprise.data: {
. announcement
. expires_at
. user_dismissible
} (object) required
delete_enterprise_announcementRemoves the global announcement banner in your enterprise.No parameters
get_enterprise_settings_licenseGet license informationNo parameters
get_enterprise_stats_allGet all statisticsNo parameters
get_enterprise_stats_commentsGet comment statisticsNo parameters
get_enterprise_stats_gistsGet gist statisticsNo parameters
get_enterprise_stats_hooksGet hooks statisticsNo parameters
get_enterprise_stats_issuesGet issue statisticsNo parameters
get_enterprise_stats_milestonesGet milestone statisticsNo parameters
get_enterprise_stats_orgsGet organization statisticsNo parameters
get_enterprise_stats_pagesGet pages statisticsNo parameters
get_enterprise_stats_pullsGet pull request statisticsNo parameters
get_enterprise_stats_reposGet repository statisticsNo parameters
get_enterprise_stats_security_productsGets the statistics about security products for a GitHub Enterprise Server instance. To use this endpoint, you must be a site admin.No parameters
get_enterprise_stats_usersGet users statisticsNo parameters
get_enterprises_by_enterprise_actions_cache_usageGets the total GitHub Actions cache usage for an enterprise. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. OAuth tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
get_enterprises_by_enterprise_actions_cache_usage_policyGets the GitHub Actions cache usage policy for an enterprise. OAuth tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
patch_enterprises_by_enterprise_actions_cache_usage_policySets the GitHub Actions cache usage policy for an enterprise. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
data: {
. repo_cache_size_limit_in_gb (integer)
. max_repo_cache_size_limit_in_gb (integer)
} (object) required
get_enterprises_by_enterprise_actions_permissionsGets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
put_enterprises_by_enterprise_actions_permissionsSets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
data: {
. enabled_organizations (string)
. allowed_actions (string)
} (object) required
get_enterprises_by_enterprise_actions_permissions_organizationsLists 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 set-github-actions-permissions-for-an-enterprise.' OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
per_page (integer)
page (integer)
put_enterprises_by_enterprise_actions_permissions_organizationsReplaces 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 set-github-actions-permissions-for-an-enterprise.' OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
data: {
. selected_organization_ids (array)
} (object) required
put_enterprises_by_enterprise_actions_permissions_organizations_by_org_idAdds 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 set-github-actions-permissions-for-an-enterprise.' OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
org_id (integer)
delete_enterprises_by_enterprise_actions_permissions_organizations_by_org_idRemoves 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 set-github-actions-permissions-for-an-enterprise.' OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
org_id (integer)
get_enterprises_by_enterprise_actions_permissions_selected_actionsGets 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 set-github-actions-permissions-for-an-enterprise.' OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
put_enterprises_by_enterprise_actions_permissions_selected_actionsSets 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 set-github-actions-permissions-for-an-enterprise.' OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
data: {
. github_owned_allowed (boolean)
. verified_allowed (boolean)
. patterns_allowed (array)
} (object) required
get_enterprises_by_enterprise_actions_permissions_workflowGets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see 'Enforcing a policy for workflow permissions in your enterprisehttps://docs.github.com/enterprise-server@3.18/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise enforcing-a-policy-for-workflow-permissions-in-your-enterprise.' OAuenterprise (string)
put_enterprises_by_enterprise_actions_permissions_workflowSets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets whether GitHub Actions can submit approving pull request reviews. For more information, see 'Enforcing a policy for workflow permissions in your enterprisehttps://docs.github.com/enterprise-server@3.18/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise enforcing-a-policy-for-workflow-permissions-in-your-enterprise.' OAuthenterprise (string)
data: {
. default_workflow_permissions
. can_approve_pull_request_reviews
} (object) required
get_enterprises_by_enterprise_actions_runner_groupsLists all self-hosted runner groups for an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
per_page (integer)
page (integer)
visible_to_organization (string)
post_enterprises_by_enterprise_actions_runner_groupsCreates a new self-hosted runner group for an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
data: {
. name (string)
. visibility (string)
. selected_organization_ids (array)
. runners (array)
. allows_public_repositories (boolean)
. restricted_to_workflows (boolean)
. selected_workflows (array)
} (object) required
get_enterprises_by_enterprise_actions_runner_groups_by_runner_group_idGets a specific self-hosted runner group for an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
patch_enterprises_by_enterprise_actions_runner_groups_by_runner_group_idUpdates the name and visibility of a self-hosted runner group in an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
data: {
. name (string)
. visibility (string)
. allows_public_repositories (boolean)
. restricted_to_workflows (boolean)
. selected_workflows (array)
} (object) required
delete_enterprises_by_enterprise_actions_runner_groups_by_runner_group_idDeletes a self-hosted runner group for an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
get_enterprises_by_enterprise_actions_runner_groups_by_runner_group_id_organizationsLists the organizations with access to a self-hosted runner group. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
per_page (integer)
page (integer)
put_enterprises_by_enterprise_actions_runner_groups_by_runner_group_id_organizationsReplaces the list of organizations that have access to a self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
data: {
. selected_organization_ids (array)
} (object) required
put_enterprises_by_enterprise_actions_runner_groups_by_runner_group_id_organizations_by_org_idAdds 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 create-a-self-hosted-runner-group-for-an-enterprise.' OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
org_id (integer)
delete_enterprises_by_enterprise_actions_runner_groups_by_runner_group_id_organizations_by_org_idRemoves 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 create-a-self-hosted-runner-group-for-an-enterprise.' OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
org_id (integer)
get_enterprises_by_enterprise_actions_runner_groups_by_runner_group_id_runnersLists the self-hosted runners that are in a specific enterprise group. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
per_page (integer)
page (integer)
put_enterprises_by_enterprise_actions_runner_groups_by_runner_group_id_runnersReplaces the list of self-hosted runners that are part of an enterprise runner group. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
data: {
. runners (array)
} (object) required
put_enterprises_by_enterprise_actions_runner_groups_by_runner_group_id_runners_by_runner_idAdds a self-hosted runner to a runner group configured in an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
runner_id (integer)
delete_enterprises_by_enterprise_actions_runner_groups_by_runner_group_id_runners_by_runner_idRemoves a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_group_id (integer)
runner_id (integer)
get_enterprises_by_enterprise_actions_runnersLists all self-hosted runners configured for an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
name (string)
per_page (integer)
page (integer)
get_enterprises_by_enterprise_actions_runners_downloadsLists binaries for the runner application that you can download and run. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
post_enterprises_by_enterprise_actions_runners_generate_jitconfigGenerates a configuration that can be passed to the runner application at startup. OAuth tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
data: {
. name (string)
. runner_group_id (integer)
. labels (array)
. work_folder (string)
} (object) required
post_enterprises_by_enterprise_actions_runners_registration_tokenReturns a token that you can pass to the config script. The token expires after one hour. Example using registration token: Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint. ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
post_enterprises_by_enterprise_actions_runners_remove_tokenReturns 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. Example using remove token: To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this endpoint. ./config.sh remove --token TOKEN OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
get_enterprises_by_enterprise_actions_runners_by_runner_idGets a specific self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_id (integer)
delete_enterprises_by_enterprise_actions_runners_by_runner_idForces 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. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_id (integer)
get_enterprises_by_enterprise_actions_runners_by_runner_id_labelsLists all labels for a self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_id (integer)
post_enterprises_by_enterprise_actions_runners_by_runner_id_labelsAdd custom labels to a self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_id (integer)
data: {
. labels (array)
} (object) required
put_enterprises_by_enterprise_actions_runners_by_runner_id_labelsRemove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an enterprise. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_id (integer)
data: {
. labels (array)
} (object) required
delete_enterprises_by_enterprise_actions_runners_by_runner_id_labelsRemove all custom labels from a self-hosted runner configured in an enterprise. Returns the remaining read-only labels from the runner. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_id (integer)
delete_enterprises_by_enterprise_actions_runners_by_runner_id_labels_by_nameRemove a custom label from a self-hosted runner configured in an enterprise. Returns the remaining labels from the runner. This endpoint returns a 404 Not Found status if the custom label is not present on the runner. OAuth app tokens and personal access tokens classic need the manage_runners:enterprise scope to use this endpoint.enterprise (string)
runner_id (integer)
name (string)
get_enterprises_by_enterprise_audit_logGets the audit log for an enterprise. The authenticated user must be an enterprise admin to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
phrase (string)
include (string)
after (string)
before (string)
order (string)
page (integer)
per_page (integer)
get_enterprises_by_enterprise_audit_log_stream_keyRetrieves the audit log streaming public key for encrypting secrets. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See 'Encrypting secrets for the REST API/rest/guides/encrypting-secrets-for-the-rest-api.'enterprise (string)
get_enterprises_by_enterprise_audit_log_streamsLists the configured audit log streaming configurations for an enterprise. This only lists configured streams for supported providers. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See 'Encrypting secrets for the REST API/rest/guides/encrypting-secrets-for-the-rest-api.'enterprise (string)
post_enterprises_by_enterprise_audit_log_streamsCreates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See 'Encrypting secrets for the REST API/rest/guides/encrypting-secrets-for-the-rest-api.'enterprise (string)
data: {
. enabled (boolean)
. stream_type (string)
. vendor_specific (object)
} (object) required
get_enterprises_by_enterprise_audit_log_streams_by_stream_idLists one audit log stream configuration via a stream ID. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See 'Encrypting secrets for the REST API/rest/guides/encrypting-secrets-for-the-rest-api.'enterprise (string)
stream_id (integer)
put_enterprises_by_enterprise_audit_log_streams_by_stream_idUpdates an existing audit log stream configuration for an enterprise. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See 'Encrypting secrets for the REST API/rest/guides/encrypting-secrets-for-the-rest-api.'enterprise (string)
stream_id (integer)
data: {
. enabled (boolean)
. stream_type (string)
. vendor_specific (object)
} (object) required
delete_enterprises_by_enterprise_audit_log_streams_by_stream_idDeletes an existing audit log stream configuration for an enterprise. When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See 'Encrypting secrets for the REST API/rest/guides/encrypting-secrets-for-the-rest-api.'enterprise (string)
stream_id (integer)
get_enterprises_by_enterprise_code_scanning_alertsLists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see 'Managing security managers in your organizationhttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization.' The authenticated user must be a meenterprise (string)
tool_name (undefined)
tool_guid (undefined)
before (string)
after (string)
page (integer)
per_page (integer)
direction (string)
state (string)
sort (string)
get_enterprises_by_enterprise_code_security_configurationsLists all code security configurations available in an enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens classic need the read:enterprise scope to use this endpoint. !NOTE The enablement status will only be returned for installed security products.enterprise (string)
per_page (integer)
before (string)
after (string)
post_enterprises_by_enterprise_code_security_configurationsCreates a code security configuration in an enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint. !NOTE Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.enterprise (string)
data: {
. name (string)
. description (string)
. advanced_security (string)
. dependency_graph (string)
. dependabot_alerts (string)
. dependabot_security_updates (string)
. code_scanning_default_setup (string)
. code_scanning_default_setup_options (object)
. code_scanning_delegated_alert_dismissal (string)
. secret_scanning (string)
. secret_scanning_push_protection (string)
. secret_scanning_validity_checks (string)
. secret_scanning_non_provider_patterns (string)
. secret_scanning_delegated_alert_dismissal (string)
. private_vulnerability_reporting (string)
. enforcement (string)
} (object) required
get_enterprises_by_enterprise_code_security_configurations_defaultsLists the default code security configurations for an enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens classic need the read:enterprise scope to use this endpoint.enterprise (string)
get_enterprises_by_enterprise_code_security_configurations_by_configuration_idGets a code security configuration available in an enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens classic need the read:enterprise scope to use this endpoint. !NOTE Any security products that are not installed will report an unset status.enterprise (string)
configuration_id (integer)
patch_enterprises_by_enterprise_code_security_configurations_by_configuration_idUpdates a code security configuration in an enterprise. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint. !NOTE The enablement status will only be returned for installed security products.enterprise (string)
configuration_id (integer)
data: {
. name (string)
. description (string)
. advanced_security (string)
. dependency_graph (string)
. dependabot_alerts (string)
. dependabot_security_updates (string)
. code_scanning_default_setup (string)
. code_scanning_default_setup_options (object)
. code_scanning_delegated_alert_dismissal (string)
. secret_scanning (string)
. secret_scanning_push_protection (string)
. secret_scanning_validity_checks (string)
. secret_scanning_non_provider_patterns (string)
. secret_scanning_delegated_alert_dismissal (string)
. private_vulnerability_reporting (string)
. enforcement (string)
} (object) required
delete_enterprises_by_enterprise_code_security_configurations_by_configuration_idDeletes a code security configuration from an enterprise. Repositories attached to the configuration will retain their settings but will no longer be associated with the configuration. The authenticated user must be an administrator for the enterprise to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.enterprise (string)
configuration_id (integer)
post_enterprises_by_enterprise_code_security_configurations_by_configuration_id_attachAttaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. The authenticated user must be an administrator for the enterprise to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to uenterprise (string)
configuration_id (integer)
data: {
. scope (string)
} (object) required
put_enterprises_by_enterprise_code_security_configurations_by_configuration_id_defaultsSets a code security configuration as a default to be applied to new repositories in your enterprise. This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. The authenticated user must be an administrator for the enterprise to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this eenterprise (string)
configuration_id (integer)
data: {
. default_for_new_repos (string)
} (object) required
get_enterprises_by_enterprise_code_security_configurations_by_configuration_id_repositoriesLists the repositories associated with an enterprise code security configuration in an organization. The authenticated user must be an administrator of the enterprise in order to use this endpoint. OAuth app tokens and personal access tokens classic need the read:enterprise scope to use this endpoint.enterprise (string)
configuration_id (integer)
per_page (integer)
before (string)
after (string)
status (string)
get_enterprises_by_enterprise_code_security_and_analysis!WARNING Closing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurationshttps://docs.github.com/enterprise-server@3.18/rest/code-security/configurations instead. For more information, see the changeloghttps://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis. Gets code security and analysis settings for the specified enterprise. The authenticated useenterprise (string)
patch_enterprises_by_enterprise_code_security_and_analysis!WARNING Closing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurationshttps://docs.github.com/enterprise-server@3.18/rest/code-security/configurations instead. For more information, see the changeloghttps://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis. Updates the settings for advanced security, Dependabot alerts, secret scanning, and push proenterprise (string)
data: {
. advanced_security_enabled_for_new_repositories (boolean)
. advanced_security_enabled_new_user_namespace_repos (boolean)
. dependabot_alerts_enabled_for_new_repositories (boolean)
. secret_scanning_enabled_for_new_repositories (boolean)
. secret_scanning_push_protection_enabled_for_new_repositories (boolean)
. secret_scanning_push_protection_custom_link (string)
. secret_scanning_non_provider_patterns_enabled_for_new_repositories (boolean)
} (object) required
get_enterprises_by_enterprise_dependabot_alertsLists Dependabot alerts for repositories that are owned by the specified enterprise. The authenticated user must be a member of the enterprise to use this endpoint. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see 'Managing security managers in your organizationhttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-enterprise (string)
state (string)
severity (string)
ecosystem (string)
package (string)
epss_percentage (string)
has (undefined)
scope (string)
sort (string)
direction (string)
before (string)
after (string)
first (integer)
last (integer)
per_page (integer)
get_enterprises_by_enterprise_properties_schemaGets all custom properties defined for an enterprise. Enterprise members can read these properties.enterprise (string)
patch_enterprises_by_enterprise_properties_schemaCreates new or updates existing custom properties defined for an enterprise in a batch. If the property already exists, the existing property will be replaced with the new values. Missing optional values will fall back to default values, previous values will be overwritten. E.g. if a property exists with values_editable_by: org_and_repo_actors and it's updated without specifying values_editable_by, it will be updated to default value org_actors. To use this endpoint, the authenticated user musenterprise (string)
data: {
. properties (array)
} (object) required
put_enterprises_by_enterprise_properties_schema_organizations_by_org_by_custom_property_name_promotePromotes an existing organization custom property to an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise.enterprise (string)
org (string)
custom_property_name (string)
get_enterprises_by_enterprise_properties_schema_by_custom_property_nameGets a custom property that is defined for an enterprise. Enterprise members can read these properties.enterprise (string)
custom_property_name (string)
put_enterprises_by_enterprise_properties_schema_by_custom_property_nameCreates a new or updates an existing custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise.enterprise (string)
custom_property_name (string)
data: {
. value_type (string)
. required (boolean)
. default_value
. description (string)
. allowed_values (array)
. values_editable_by (string)
} (object) required
delete_enterprises_by_enterprise_properties_schema_by_custom_property_nameRemove a custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise.enterprise (string)
custom_property_name (string)
get_enterprises_by_enterprise_secret_scanning_alertsLists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. To use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security managerhttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-manageenterprise (string)
state (string)
secret_type (string)
resolution (string)
sort (string)
direction (string)
per_page (integer)
before (string)
after (string)
validity (string)
is_publicly_leaked (boolean)
is_multi_repo (boolean)
hide_secret (boolean)
get_enterprises_by_enterprise_settings_billing_advanced_securityGets the GitHub Advanced Security active committers for an enterprise per repository. The authenticated user must be an enterprise admin or billing manager. Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository. The total number of repositories with committer information is tracked by the total_count field.enterprise (string)
advanced_security_product (string)
per_page (integer)
page (integer)
post_enterprises_by_enterprise_by_security_product_by_enablement!WARNING Closing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurationshttps://docs.github.com/enterprise-server@3.18/rest/code-security/configurations instead. For more information, see the changeloghttps://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis. Enables or disables the specified security feature for all repositories in an enterprise. The autenterprise (string)
security_product (string)
enablement (string)
get_events!NOTE This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.per_page (integer)
page (integer)
get_feedsLists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. Timeline: The GitHub Enterprise Server global public timeline User: The public timeline for any user, using uri_template. For more information, see 'Hypermediahttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api hypermedia.' Current user public: The public timeliNo parameters
get_gistsLists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:since (string)
per_page (integer)
page (integer)
post_gistsAllows 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.data: {
. description (string)
. files (object)
. public
} (object) required
get_gists_publicList public gists sorted by most recently updated to least recently updated. Note: With paginationhttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api, 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.since (string)
per_page (integer)
page (integer)
get_gists_starredList the authenticated user's starred gists:since (string)
per_page (integer)
page (integer)
get_gists_by_gist_idGets a specified gist. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type. - application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 segist_id (string)
patch_gists_by_gist_idAllows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. At least one of description or files is required. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returngist_id (string)
data: {
. description (string)
. files (object)
} (object) required
delete_gists_by_gist_idDelete a gistgist_id (string)
get_gists_by_gist_id_commentsLists the comments on a gist. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type. - application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid Ugist_id (string)
per_page (integer)
page (integer)
post_gists_by_gist_id_commentsCreates a comment on a gist. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type. - application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTgist_id (string)
data: {
. body (string)
} (object) required
get_gists_by_gist_id_comments_by_comment_idGets a comment on a gist. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type. - application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8gist_id (string)
comment_id (integer)
patch_gists_by_gist_id_comments_by_comment_idUpdates a comment on a gist. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type. - application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTgist_id (string)
comment_id (integer)
data: {
. body (string)
} (object) required
delete_gists_by_gist_id_comments_by_comment_idDelete a gist commentgist_id (string)
comment_id (integer)
get_gists_by_gist_id_commitsList gist commitsgist_id (string)
per_page (integer)
page (integer)
get_gists_by_gist_id_forksList gist forksgist_id (string)
per_page (integer)
page (integer)
post_gists_by_gist_id_forksFork a gistgist_id (string)
get_gists_by_gist_id_starCheck if a gist is starredgist_id (string)
put_gists_by_gist_id_starNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see 'HTTP methodhttps://docs.github.com/enterprise-server@3.18/rest/guides/getting-started-with-the-rest-api http-method.'gist_id (string)
delete_gists_by_gist_id_starUnstar a gistgist_id (string)
get_gists_by_gist_id_by_shaGets a specified gist revision. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type. - application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalidgist_id (string)
sha (string)
get_gitignore_templatesList all templates available to pass as an option when creating a repositoryhttps://docs.github.com/enterprise-server@3.18/rest/repos/repos create-a-repository-for-the-authenticated-user.No parameters
get_gitignore_templates_by_nameGet the content of a gitignore template. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw .gitignore contents.name (string)
get_installation_repositoriesList repositories that an app installation can access.per_page (integer)
page (integer)
delete_installation_tokenRevokes 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 apphttps://docs.github.com/enterprise-server@3.18/rest/apps/apps create-an-installation-access-token-for-an-app' endpoint.No parameters
get_issuesList 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 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_filter (string)
state (string)
labels (string)
sort (string)
direction (string)
since (string)
collab (boolean)
orgs (boolean)
owned (boolean)
pulls (boolean)
per_page (integer)
page (integer)
get_licensesLists the most commonly used licenses on GitHub. For more information, see 'Licensing a repository https://docs.github.com/enterprise-server@3.18/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.'featured (boolean)
per_page (integer)
page (integer)
get_licenses_by_licenseGets information about a specific license. For more information, see 'Licensing a repository https://docs.github.com/enterprise-server@3.18/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.'license (string)
get_manage_v1_access_sshGets the configured SSH keys on all available nodes. For more information, see 'Accessing the administrative shell SSHhttps://docs.github.com/enterprise-server@3.18/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.'No parameters
post_manage_v1_access_sshAdds a SSH key to the authorized_keys file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see 'Accessing the administrative shell SSHhttps://docs.github.com/enterprise-server@3.18/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.'data: {
. key (string)
} (object) required
delete_manage_v1_access_sshDeletes a SSH key from the authorized_keys file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see 'Accessing the administrative shell SSHhttps://docs.github.com/enterprise-server@3.18/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh.'data: {
. key (string)
} (object) required
get_manage_v1_checks_system_requirementsChecks if the minimum requirements for system hardware resources are met on each configured cluster node. This endpoint may take several seconds to reply.No parameters
get_manage_v1_cluster_statusGets the status of all services running on each cluster node. This endpoint may take several seconds to reply.No parameters
get_manage_v1_config_applyDisplays the current status of ghe-config-apply in the environment or the status of a historical run by ID.run_id (string)
post_manage_v1_config_applyTriggers a run of ghe-config-apply from the ghes-manage agent on your Nomad Delegate instance. You can provide a run ID or allow one to be generated randomly.data: {
. run_id (string)
} (object) required
get_manage_v1_config_apply_eventsLists events from an in-process ghe-config-apply run on your Github Enterprise Server instance.last_request_id (string)
post_manage_v1_config_initWhen you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. !IMPORTANT To start the configuration process and apply the license, you need to POST to /manage/v1/config/applyhttps://docs.github.com/enterprise-server@3.18/rest/enterprise-admin/manage-ghes start-configuration-apply-process The root site administrator password provided when calling this endpoint is used to authenticate for all oNo parameters
get_manage_v1_config_licenseGets information about the license that is currently set for the enterprise.No parameters
put_manage_v1_config_licenseUploads a new enterprise license. In order to apply it right away, use the apply query parameter. !NOTE The request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentationhttps://curl.se/docs/manpage.html -F.apply (boolean)
get_manage_v1_config_license_checkCheck the status of the license that is currently set for the enterprise.No parameters
get_manage_v1_config_nodesGet node metadata for all configured nodes in the current cluster. For more information, see 'About clusteringhttps://docs.github.com/enterprise-server@3.18/admin/enterprise-management/configuring-clustering/about-clustering.'uuid (string)
cluster_roles (string)
get_manage_v1_config_settingsGets a list of settings for a GitHub Enterprise Server instance.No parameters
put_manage_v1_config_settingsUpdates the settings on your instance. For a list of the available settings, see the Get settings endpointhttps://docs.github.com/enterprise-server@3.18/rest/enterprise-admin/manage-ghes get-settings. Notes: - The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values. - You cannot set the Management Console root site administrator password with this API endpoint. Use the ghe-set-pasdata (object) required
get_manage_v1_maintenanceGets the status and details of maintenance mode on all available nodes. For more information, see 'Enabling and scheduling maintenance modehttps://docs.github.com/enterprise-server@3.18/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode.'uuid (string)
cluster_roles (string)
post_manage_v1_maintenanceSets or schedules the maintenance mode. For more information, see 'Enabling and scheduling maintenance modehttps://docs.github.com/enterprise-server@3.18/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode.'data: {
. enabled (boolean)
. uuid (string)
. when (string)
. ip_exception_list (array)
. maintenance_mode_message (string)
} (object) required
get_manage_v1_replication_statusGets the status of all services running on each replica node. This endpoint may take several seconds to reply.uuid (string)
cluster_roles (string)
get_manage_v1_versionGets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see 'GitHub Enterprise Server releaseshttps://docs.github.com/enterprise-server@3.18/admin/all-releases.'uuid (string)
cluster_roles (string)
post_markdownDepending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as issues:read or pull_requests:read.data: {
. text (string)
. mode (string)
. context (string)
} (object) required
post_markdown_rawYou 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 Markdownhttps://github.github.com/gfm/ is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.No parameters
get_metaGet GitHub Enterprise Server meta informationNo parameters
get_networks_by_owner_by_repo_events!NOTE This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.owner (string)
repo (string)
per_page (integer)
page (integer)
get_notificationsList all notifications for the current user, sorted by most recently updated.all (boolean)
participating (boolean)
since (string)
before (string)
page (integer)
per_page (integer)
put_notificationsMarks all notifications as 'read' for the current user. 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 userhttps://docs.github.com/enterprise-server@3.18/rest/activity/notifications list-notifications-for-the-authenticated-user endpdata: {
. last_read_at (string)
. read (boolean)
} (object) required
get_notifications_threads_by_thread_idGets information about a notification thread.thread_id (integer)
patch_notifications_threads_by_thread_idMarks a thread as 'read.' Marking a thread as 'read' is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.thread_id (integer)
delete_notifications_threads_by_thread_idMarks a thread as 'done.' Marking a thread as 'done' is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.thread_id (integer)
get_notifications_threads_by_thread_id_subscriptionThis checks to see if the current user is subscribed to a thread. You can also get a repository subscriptionhttps://docs.github.com/enterprise-server@3.18/rest/activity/watching 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.thread_id (integer)
put_notifications_threads_by_thread_id_subscriptionIf 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 threadthread_id (integer)
data: {
. ignored (boolean)
} (object) required
delete_notifications_threads_by_thread_id_subscriptionMutes 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 subscriptionhttps://docs.github.com/enterprise-server@3.18/rest/activity/notifications set-a-thread-subscription endpoint and set ignore to true.thread_id (integer)
get_octocatGet the octocat as ASCII arts (string)
get_organizationsLists all organizations, in the order that they were created. !NOTE Pagination is powered exclusively by the since parameter. Use the Link headerhttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api using-link-headers to get the URL for the next page of organizations.since (integer)
per_page (integer)
get_organizations_by_organization_id_custom_roles!WARNING Closing down notice: This operation is closing down and will be removed in the future. Use the 'List custom repository roleshttps://docs.github.com/enterprise-server@3.18/rest/orgs/custom-roles list-custom-repository-roles-in-an-organization' endpoint instead. List the custom repository roles available in this organization. For more information on custom repository roles, see 'About custom repository roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-aorganization_id (string)
get_organizations_by_org_dependabot_repository_accessLists repositories that organization admins have allowed Dependabot to access when updating dependencies. !NOTE This operation supports both server-to-server and user-to-server access. Unauthorized users will not see the existence of this endpoint.org (string)
page (integer)
per_page (integer)
patch_organizations_by_org_dependabot_repository_accessUpdates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. !NOTE This operation supports both server-to-server and user-to-server access. Unauthorized users will not see the existence of this endpoint. Example request body: json 'repository_ids_to_add': 123, 456, 'repository_ids_to_remove': 789org (string)
data: {
. repository_ids_to_add (array)
. repository_ids_to_remove (array)
} (object) required
put_organizations_by_org_dependabot_repository_access_default_levelSets the default level of repository access Dependabot will have while performing an update. Available values are: - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. Unauthorized users will not see the existence of this endpoint. This operation supports both server-toorg (string)
data: {
. default_level (string)
} (object) required
get_orgs_by_orgGets information about an organization. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authenticationhttps://docs.github.com/enterprise-server@3.18/articles/securing-your-account-with-two-factor-authentication-2fa/. To see the full details about an organization, the authenorg (string)
patch_orgs_by_org!WARNING Closing down 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 poorg (string)
data: {
. billing_email (string)
. company (string)
. email (string)
. twitter_username (string)
. location (string)
. name (string)
. description (string)
. has_organization_projects (boolean)
. has_repository_projects (boolean)
. default_repository_permission (string)
. members_can_create_repositories (boolean)
. members_can_create_internal_repositories (boolean)
. members_can_create_private_repositories (boolean)
. members_can_create_public_repositories (boolean)
. members_allowed_repository_creation_type (string)
. members_can_create_pages (boolean)
. members_can_fork_private_repositories (boolean)
. web_commit_signoff_required (boolean)
. blog (string)
. advanced_security_enabled_for_new_repositories (boolean)
. dependabot_alerts_enabled_for_new_repositories (boolean)
. dependabot_security_updates_enabled_for_new_repositories (boolean)
. dependency_graph_enabled_for_new_repositories (boolean)
. secret_scanning_enabled_for_new_repositories (boolean)
. secret_scanning_push_protection_enabled_for_new_repositories (boolean)
. secret_scanning_push_protection_custom_link_enabled (boolean)
. secret_scanning_push_protection_custom_link (string)
. deploy_keys_enabled_for_repositories (boolean)
} (object) required
delete_orgs_by_orgDeletes an organization and all its repositories. The organization login will be unavailable for 90 days after deletion. Please review the Terms of Service regarding account deletion before using this endpoint: https://docs.github.com/enterprise-server@3.18/site-policy/github-terms/github-terms-of-serviceorg (string)
get_orgs_by_org_actions_cache_usageGets the total GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. OAuth tokens and personal access tokens classic need the read:org scope to use this endpoint.org (string)
get_orgs_by_org_actions_cache_usage_by_repositoryLists repositories and their GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. OAuth tokens and personal access tokens classic need the read:org scope to use this endpoint.org (string)
per_page (integer)
page (integer)
get_orgs_by_org_actions_oidc_customization_subGets the customization template for an OpenID Connect OIDC subject claim. OAuth app tokens and personal access tokens classic need the read:org scope to use this endpoint.org (string)
put_orgs_by_org_actions_oidc_customization_subCreates or updates the customization template for an OpenID Connect OIDC subject claim. OAuth app tokens and personal access tokens classic need the write:org scope to use this endpoint.org (string)
data: {
. include_claim_keys (array)
} (object) required
get_orgs_by_org_actions_permissionsGets 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.org (string)
put_orgs_by_org_actions_permissionsSets 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. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
data: {
. enabled_repositories (string)
. allowed_actions (string)
} (object) required
get_orgs_by_org_actions_permissions_repositoriesLists 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 set-github-actions-permissions-for-an-organization.' OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
per_page (integer)
page (integer)
put_orgs_by_org_actions_permissions_repositoriesReplaces 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 set-github-actions-permissions-for-an-organization.' OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
data: {
. selected_repository_ids (array)
} (object) required
put_orgs_by_org_actions_permissions_repositories_by_repository_idAdds 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 set-github-actions-permissions-for-an-organization.' OAuth tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
repository_id (integer)
delete_orgs_by_org_actions_permissions_repositories_by_repository_idRemoves 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 set-github-actions-permissions-for-an-organization.' OAuth tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
repository_id (integer)
get_orgs_by_org_actions_permissions_selected_actionsGets 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 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.org (string)
put_orgs_by_org_actions_permissions_selected_actionsSets 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 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 sorg (string)
data: {
. github_owned_allowed (boolean)
. verified_allowed (boolean)
. patterns_allowed (array)
} (object) required
get_orgs_by_org_actions_permissions_workflowGets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, as well as whether GitHub Actions can submit approving pull request reviews. For more information, see 'Setting the permissions of the GITHUB_TOKEN for your organizationhttps://docs.github.com/enterprise-server@3.18/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization setting-the-permissions-of-the-github_token-for-your-organization.' OAorg (string)
put_orgs_by_org_actions_permissions_workflowSets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions can submit approving pull request reviews. For more information, see 'Setting the permissions of the GITHUB_TOKEN for your organizationhttps://docs.github.com/enterprise-server@3.18/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization setting-the-permissions-of-the-github_token-for-your-organization.' OAuth apporg (string)
data: {
. default_workflow_permissions
. can_approve_pull_request_reviews
} (object) required
get_orgs_by_org_actions_runner_groupsLists all self-hosted runner groups configured in an organization and inherited from an enterprise. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
per_page (integer)
page (integer)
visible_to_repository (string)
post_orgs_by_org_actions_runner_groupsCreates a new self-hosted runner group for an organization. OAuth tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
data: {
. name (string)
. visibility (string)
. selected_repository_ids (array)
. runners (array)
. allows_public_repositories (boolean)
. restricted_to_workflows (boolean)
. selected_workflows (array)
} (object) required
get_orgs_by_org_actions_runner_groups_by_runner_group_idGets a specific self-hosted runner group for an organization. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
patch_orgs_by_org_actions_runner_groups_by_runner_group_idUpdates the name and visibility of a self-hosted runner group in an organization. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
data: {
. name (string)
. visibility (string)
. allows_public_repositories (boolean)
. restricted_to_workflows (boolean)
. selected_workflows (array)
} (object) required
delete_orgs_by_org_actions_runner_groups_by_runner_group_idDeletes a self-hosted runner group for an organization. OAuth tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
get_orgs_by_org_actions_runner_groups_by_runner_group_id_repositoriesLists the repositories with access to a self-hosted runner group configured in an organization. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
page (integer)
per_page (integer)
put_orgs_by_org_actions_runner_groups_by_runner_group_id_repositoriesReplaces the list of repositories that have access to a self-hosted runner group configured in an organization. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
data: {
. selected_repository_ids (array)
} (object) required
put_orgs_by_org_actions_runner_groups_by_runner_group_id_repositories_by_repository_idAdds a repository to the list of 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 create-a-self-hosted-runner-group-for-an-organization.' OAuth tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
repository_id (integer)
delete_orgs_by_org_actions_runner_groups_by_runner_group_id_repositories_by_repository_idRemoves 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 create-a-self-hosted-runner-group-for-an-organization.' OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
repository_id (integer)
get_orgs_by_org_actions_runner_groups_by_runner_group_id_runnersLists self-hosted runners that are in a specific organization group. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
per_page (integer)
page (integer)
put_orgs_by_org_actions_runner_groups_by_runner_group_id_runnersReplaces the list of self-hosted runners that are part of an organization runner group. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
data: {
. runners (array)
} (object) required
put_orgs_by_org_actions_runner_groups_by_runner_group_id_runners_by_runner_idAdds a self-hosted runner to a runner group configured in an organization. OAuth tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
runner_id (integer)
delete_orgs_by_org_actions_runner_groups_by_runner_group_id_runners_by_runner_idRemoves a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_group_id (integer)
runner_id (integer)
get_orgs_by_org_actions_runnersLists all self-hosted runners configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
name (string)
per_page (integer)
page (integer)
get_orgs_by_org_actions_runners_downloadsLists binaries for the runner application that you can download and run. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
post_orgs_by_org_actions_runners_generate_jitconfigGenerates a configuration that can be passed to the runner application at startup. The authenticated user must have admin access to the organization. OAuth tokens and personal access tokens classic need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.org (string)
data: {
. name (string)
. runner_group_id (integer)
. labels (array)
. work_folder (string)
} (object) required
post_orgs_by_org_actions_runners_registration_tokenReturns a token that you can pass to the config script. The token expires after one hour. For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner: ./config.sh --url https://github.com/octo-org --token TOKEN Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens classic need theadmin:org scope to use this endpoint. If the reposiorg (string)
post_orgs_by_org_actions_runners_remove_tokenReturns 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. For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: ./config.sh remove --token TOKEN Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens classic need theadmin:ororg (string)
get_orgs_by_org_actions_runners_by_runner_idGets a specific self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
runner_id (integer)
delete_orgs_by_org_actions_runners_by_runner_idForces 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. Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens classic need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.org (string)
runner_id (integer)
get_orgs_by_org_actions_runners_by_runner_id_labelsLists all labels for a self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
runner_id (integer)
post_orgs_by_org_actions_runners_by_runner_id_labelsAdds custom labels to a self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
runner_id (integer)
data: {
. labels (array)
} (object) required
put_orgs_by_org_actions_runners_by_runner_id_labelsRemove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
runner_id (integer)
data: {
. labels (array)
} (object) required
delete_orgs_by_org_actions_runners_by_runner_id_labelsRemove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
runner_id (integer)
delete_orgs_by_org_actions_runners_by_runner_id_labels_by_nameRemove a custom label from a self-hosted runner configured in an organization. Returns the remaining labels from the runner. This endpoint returns a 404 Not Found status if the custom label is not present on the runner. Authenticated users must have admin access to the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
runner_id (integer)
name (string)
get_orgs_by_org_actions_secretsLists all secrets available in an organization without revealing their encrypted values. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
per_page (integer)
page (integer)
get_orgs_by_org_actions_secrets_public_keyGets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. The authenticated user must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens classic need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.org (string)
get_orgs_by_org_actions_secrets_by_secret_nameGets a single organization secret without revealing its encrypted value. The authenticated user must have collaborator access to a repository to create, update, or read secrets OAuth tokens and personal access tokens classic need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.org (string)
secret_name (string)
put_orgs_by_org_actions_secrets_by_secret_nameCreates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodiumhttps://libsodium.gitbook.io/doc/bindings_for_other_languages. For more information, see 'Encrypting secrets for the REST APIhttps://docs.github.com/enterprise-server@3.18/rest/guides/encrypting-secrets-for-the-rest-api.' Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens classic need theadmin:org scopeorg (string)
secret_name (string)
data: {
. encrypted_value (string)
. key_id (string)
. visibility (string)
. selected_repository_ids (array)
} (object) required
delete_orgs_by_org_actions_secrets_by_secret_nameDeletes a secret in an organization using the secret name. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens classic need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.org (string)
secret_name (string)
get_orgs_by_org_actions_secrets_by_secret_name_repositoriesLists all repositories that have been selected when the visibility for repository access to a secret is set to selected. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
secret_name (string)
page (integer)
per_page (integer)
put_orgs_by_org_actions_secrets_by_secret_name_repositoriesReplaces 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 secrethttps://docs.github.com/enterprise-server@3.18/rest/actions/secrets create-or-update-an-organization-secret. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. Iforg (string)
secret_name (string)
data: {
. selected_repository_ids (array)
} (object) required
put_orgs_by_org_actions_secrets_by_secret_name_repositories_by_repository_idAdds a repository to an organization secret when the visibility for repository access is set to selected. For more information about setting the visibility, see Create or update an organization secrethttps://docs.github.com/enterprise-server@3.18/rest/actions/secrets create-or-update-an-organization-secret. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens classic need the admin:org scope to use this enorg (string)
secret_name (string)
repository_id (integer)
delete_orgs_by_org_actions_secrets_by_secret_name_repositories_by_repository_idRemoves 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 secrethttps://docs.github.com/enterprise-server@3.18/rest/actions/secrets create-or-update-an-organization-secret. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If theorg (string)
secret_name (string)
repository_id (integer)
get_orgs_by_org_actions_variablesLists all organization variables. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
per_page (integer)
page (integer)
post_orgs_by_org_actions_variablesCreates an organization variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens classic need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.org (string)
data: {
. name (string)
. value (string)
. visibility (string)
. selected_repository_ids (array)
} (object) required
get_orgs_by_org_actions_variables_by_nameGets a specific variable in an organization. The authenticated user must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens classic need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.org (string)
name (string)
patch_orgs_by_org_actions_variables_by_nameUpdates an organization variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
name (string)
data: {
. name (string)
. value (string)
. visibility (string)
. selected_repository_ids (array)
} (object) required
delete_orgs_by_org_actions_variables_by_nameDeletes an organization variable using the variable name. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens classic need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.org (string)
name (string)
get_orgs_by_org_actions_variables_by_name_repositoriesLists all repositories that can access an organization variable that is available to selected repositories. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
name (string)
page (integer)
per_page (integer)
put_orgs_by_org_actions_variables_by_name_repositoriesReplaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
name (string)
data: {
. selected_repository_ids (array)
} (object) required
put_orgs_by_org_actions_variables_by_name_repositories_by_repository_idAdds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope torg (string)
name (string)
repository_id (integer)
delete_orgs_by_org_actions_variables_by_name_repositories_by_repository_idRemoves a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.org (string)
name (string)
repository_id (integer)
get_orgs_by_org_announcementGets the announcement banner currently set for the organization. Only returns the announcement banner set at the organization level. Organization members may also see an enterprise-level announcement banner. To get an announcement banner displayed at the enterprise level, use the enterprise-level endpoint.org (string)
patch_orgs_by_org_announcementSets the announcement banner to display for the organization.org (string)
data: {
. announcement
. expires_at
. user_dismissible
} (object) required
delete_orgs_by_org_announcementRemoves the announcement banner currently set for the organization.org (string)
get_orgs_by_org_audit_logGets the audit log for an organization. For more information, see 'Reviewing the audit log for your organizationhttps://docs.github.com/enterprise-server@3.18/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.' By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based oorg (string)
phrase (string)
include (string)
after (string)
before (string)
order (string)
per_page (integer)
page (integer)
get_orgs_by_org_bypass_requests_push_rulesLists the requests made by users of a repository to bypass push protection rules within an organization.org (string)
repository_name (string)
reviewer (string)
requester (string)
time_period (string)
request_status (string)
per_page (integer)
page (integer)
get_orgs_by_org_bypass_requests_secret_scanningList requests to bypass secret scanning push protection in an org. Delegated bypass must be enabled on repositories in the org and the user must be a bypass reviewer to access this endpoint. Personal access tokens classic need the security_events scope to use this endpoint.org (string)
repository_name (string)
reviewer (string)
requester (string)
time_period (string)
request_status (string)
per_page (integer)
page (integer)
get_orgs_by_org_code_scanning_alertsLists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see 'Managing security managers in your organizationhttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization.' The authenticated user must be anorg (string)
tool_name (undefined)
tool_guid (undefined)
before (string)
after (string)
page (integer)
per_page (integer)
direction (string)
state (string)
sort (string)
severity (string)
get_orgs_by_org_code_security_configurationsLists all code security configurations available in an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the read:org scope to use this endpoint. !NOTE The enablement status will only be returned for installed security products.org (string)
target_type (string)
per_page (integer)
before (string)
after (string)
post_orgs_by_org_code_security_configurationsCreates a code security configuration in an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the write:org scope to use this endpoint. !NOTE Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.org (string)
data: {
. name (string)
. description (string)
. advanced_security (string)
. dependency_graph (string)
. dependabot_alerts (string)
. dependabot_security_updates (string)
. code_scanning_default_setup (string)
. code_scanning_default_setup_options (object)
. code_scanning_delegated_alert_dismissal (string)
. secret_scanning (string)
. secret_scanning_push_protection (string)
. secret_scanning_delegated_bypass (string)
. secret_scanning_delegated_bypass_options (object)
. secret_scanning_validity_checks (string)
. secret_scanning_non_provider_patterns (string)
. secret_scanning_delegated_alert_dismissal (string)
. private_vulnerability_reporting (string)
. enforcement (string)
} (object) required
get_orgs_by_org_code_security_configurations_defaultsLists the default code security configurations for an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. !NOTE The enablement status will only be returned for installed security products.org (string)
delete_orgs_by_org_code_security_configurations_detachDetach code security configurations from a set of repositories. Repositories will retain their settings but will no longer be associated with the configuration. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the write:org scope to use this endpoint.org (string)
data: {
. selected_repository_ids (array)
} (object) required
get_orgs_by_org_code_security_configurations_by_configuration_idGets a code security configuration available in an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the write:org scope to use this endpoint. !NOTE The enablement status will only be returned for installed security products.org (string)
configuration_id (integer)
patch_orgs_by_org_code_security_configurations_by_configuration_idUpdates a code security configuration in an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the write:org scope to use this endpoint. !NOTE Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.org (string)
configuration_id (integer)
data: {
. name (string)
. description (string)
. advanced_security (string)
. dependency_graph (string)
. dependabot_alerts (string)
. dependabot_security_updates (string)
. code_scanning_default_setup (string)
. code_scanning_default_setup_options (object)
. code_scanning_delegated_alert_dismissal (string)
. secret_scanning (string)
. secret_scanning_push_protection (string)
. secret_scanning_delegated_bypass (string)
. secret_scanning_delegated_bypass_options (object)
. secret_scanning_validity_checks (string)
. secret_scanning_non_provider_patterns (string)
. secret_scanning_delegated_alert_dismissal (string)
. private_vulnerability_reporting (string)
. enforcement (string)
} (object) required
delete_orgs_by_org_code_security_configurations_by_configuration_idDeletes the desired code security configuration from an organization. Repositories attached to the configuration will retain their settings but will no longer be associated with the configuration. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the write:org scope to use this endpoint.org (string)
configuration_id (integer)
post_orgs_by_org_code_security_configurations_by_configuration_id_attachAttach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the write:orgorg (string)
configuration_id (integer)
data: {
. scope (string)
. selected_repository_ids (array)
} (object) required
put_orgs_by_org_code_security_configurations_by_configuration_id_defaultsSets a code security configuration as a default to be applied to new repositories in your organization. This configuration will be applied to the matching repository type all, none, public, private and internal by default when they are created. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the write:org scope to use this endpoint. !NOTE The enablement status will only borg (string)
configuration_id (integer)
data: {
. default_for_new_repos (string)
} (object) required
get_orgs_by_org_code_security_configurations_by_configuration_id_repositoriesLists the repositories associated with a code security configuration in an organization. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the read:org scope to use this endpoint.org (string)
configuration_id (integer)
per_page (integer)
before (string)
after (string)
status (string)
get_orgs_by_org_custom_repository_rolesList the custom repository roles available in this organization. For more information on custom repository roles, see 'About custom repository roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles.' The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org oorg (string)
post_orgs_by_org_custom_repository_rolesCreates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see 'About custom repository roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles.' The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope torg (string)
data: {
. name (string)
. description (string)
. base_role (string)
. permissions (array)
} (object) required
get_orgs_by_org_custom_repository_roles_by_role_idGets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see 'About custom repository roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles.' The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. OAuth app tokens and personal access tokenorg (string)
role_id (integer)
patch_orgs_by_org_custom_repository_roles_by_role_idUpdates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see 'About custom repository roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles.' The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scoporg (string)
role_id (integer)
data: {
. name (string)
. description (string)
. base_role (string)
. permissions (array)
} (object) required
delete_orgs_by_org_custom_repository_roles_by_role_idDeletes a custom role from an organization. Once the custom role has been deleted, any user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see 'About custom repository roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles.' The authenticated user must be an administrator for the organization to use this enorg (string)
role_id (integer)
get_orgs_by_org_dependabot_alertsLists Dependabot alerts for an organization. The authenticated user must be an owner or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.org (string)
state (string)
severity (string)
ecosystem (string)
package (string)
epss_percentage (string)
artifact_registry_url (string)
artifact_registry (string)
has (undefined)
runtime_risk (string)
scope (string)
sort (string)
direction (string)
before (string)
after (string)
first (integer)
last (integer)
per_page (integer)
get_orgs_by_org_dependabot_secretsLists all secrets available in an organization without revealing their encrypted values. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
per_page (integer)
page (integer)
get_orgs_by_org_dependabot_secrets_public_keyGets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
get_orgs_by_org_dependabot_secrets_by_secret_nameGets a single organization secret without revealing its encrypted value. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
secret_name (string)
put_orgs_by_org_dependabot_secrets_by_secret_nameCreates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodiumhttps://libsodium.gitbook.io/doc/bindings_for_other_languages. For more information, see 'Encrypting secrets for the REST APIhttps://docs.github.com/enterprise-server@3.18/rest/guides/encrypting-secrets-for-the-rest-api.' OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
secret_name (string)
data: {
. encrypted_value (string)
. key_id (string)
. visibility (string)
. selected_repository_ids (array)
} (object) required
delete_orgs_by_org_dependabot_secrets_by_secret_nameDeletes a secret in an organization using the secret name. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
secret_name (string)
get_orgs_by_org_dependabot_secrets_by_secret_name_repositoriesLists all repositories that have been selected when the visibility for repository access to a secret is set to selected. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
secret_name (string)
page (integer)
per_page (integer)
put_orgs_by_org_dependabot_secrets_by_secret_name_repositoriesReplaces 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 secrethttps://docs.github.com/enterprise-server@3.18/rest/dependabot/secrets create-or-update-an-organization-secret. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
secret_name (string)
data: {
. selected_repository_ids (array)
} (object) required
put_orgs_by_org_dependabot_secrets_by_secret_name_repositories_by_repository_idAdds 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 secrethttps://docs.github.com/enterprise-server@3.18/rest/dependabot/secrets create-or-update-an-organization-secret. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
secret_name (string)
repository_id (integer)
delete_orgs_by_org_dependabot_secrets_by_secret_name_repositories_by_repository_idRemoves 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 secrethttps://docs.github.com/enterprise-server@3.18/rest/dependabot/secrets create-or-update-an-organization-secret. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
secret_name (string)
repository_id (integer)
get_orgs_by_org_dismissal_requests_secret_scanningLists requests to dismiss secret scanning alerts in an org. Delegated alert dismissal must be enabled on repositories in the org and the user must be an org admin, security manager, or have the 'Review and manage secret scanning alert dismissal requests' permission to access this endpoint.org (string)
repository_name (string)
reviewer (string)
requester (string)
time_period (string)
request_status (string)
per_page (integer)
page (integer)
get_orgs_by_org_docker_conflictsLists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint.org (string)
get_orgs_by_org_events!NOTE This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.org (string)
per_page (integer)
page (integer)
get_orgs_by_org_external_group_by_group_idDisplays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see 'GitHub's productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products' in the GitHub Help documentation.org (string)
group_id (integer)
per_page (integer)
page (integer)
get_orgs_by_org_external_groupsLists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see 'Offset and Curorg (string)
per_page (integer)
page (integer)
display_name (string)
get_orgs_by_org_hooksList webhooks for an organization. The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.org (string)
per_page (integer)
page (integer)
post_orgs_by_org_hooksCreate a hook that posts payloads in JSON format. You must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.org (string)
data: {
. name (string)
. config (object)
. events (array)
. active (boolean)
} (object) required
get_orgs_by_org_hooks_by_hook_idReturns a webhook configured in an organization. To get only the webhook config properties, see 'Get a webhook configuration for an organization/rest/orgs/webhooks get-a-webhook-configuration-for-an-organization. You must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.org (string)
hook_id (integer)
patch_orgs_by_org_hooks_by_hook_idUpdates 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/rest/orgs/webhooks update-a-webhook-configuration-for-an-organization'. You must be an organization owner to use this endpoint. OAuth app tokens and peorg (string)
hook_id (integer)
data: {
. config (object)
. events (array)
. active (boolean)
. name (string)
} (object) required
delete_orgs_by_org_hooks_by_hook_idDelete a webhook for an organization. The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.org (string)
hook_id (integer)
get_orgs_by_org_hooks_by_hook_id_configReturns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use 'Get an organization webhook /rest/orgs/webhooks get-an-organization-webhook.' You must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAutorg (string)
hook_id (integer)
patch_orgs_by_org_hooks_by_hook_id_configUpdates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use 'Update an organization webhook /rest/orgs/webhooks update-an-organization-webhook.' You must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were createorg (string)
hook_id (integer)
data: {
. url (string)
. content_type (string)
. secret (string)
. insecure_ssl
} (object) required
get_orgs_by_org_hooks_by_hook_id_deliveriesReturns a list of webhook deliveries for a webhook configured in an organization. You must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.org (string)
hook_id (integer)
per_page (integer)
cursor (string)
get_orgs_by_org_hooks_by_hook_id_deliveries_by_delivery_idReturns a delivery for a webhook configured in an organization. You must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.org (string)
hook_id (integer)
delivery_id (integer)
post_orgs_by_org_hooks_by_hook_id_deliveries_by_delivery_id_attemptsRedeliver a delivery for a webhook configured in an organization. You must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.org (string)
hook_id (integer)
delivery_id (integer)
post_orgs_by_org_hooks_by_hook_id_pingsThis will trigger a ping eventhttps://docs.github.com/enterprise-server@3.18/webhooks/ ping-event to be sent to the hook. You must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need admin:org_hook scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.org (string)
hook_id (integer)
get_orgs_by_org_installationEnables an authenticated GitHub App to find the organization's installation information. You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.org (string)
get_orgs_by_org_installationsLists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:read scope to use this endpoint.org (string)
per_page (integer)
page (integer)
get_orgs_by_org_issuesList issues in an organization assigned to the authenticated user. !NOTE GitHub's REST API 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 requestshttps://docs.github.comorg (string)
filter (string)
state (string)
labels (string)
type (string)
sort (string)
direction (string)
since (string)
per_page (integer)
page (integer)
get_orgs_by_org_membersList 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.org (string)
filter (string)
role (string)
per_page (integer)
page (integer)
get_orgs_by_org_members_by_usernameCheck if a user is, publicly or privately, a member of the organization.org (string)
username (string)
delete_orgs_by_org_members_by_usernameRemoving a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. !NOTE If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.org (string)
username (string)
get_orgs_by_org_memberships_by_usernameIn 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.org (string)
username (string)
put_orgs_by_org_memberships_by_usernameOnly 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 statushttps://docs.github.com/enterprise-server@3.18/rest/orgs/members get-organization-membership-for-a-user will be pending until they accept the invitation. Authenticated users can update a user's membership by passing the rolorg (string)
username (string)
data: {
. role (string)
} (object) required
delete_orgs_by_org_memberships_by_usernameIn 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. !NOTE If a user has both direct membership in the organization as well as indirect membership via an enterpriorg (string)
username (string)
get_orgs_by_org_migrationsLists the most recent migrations, including both exports which can be started through the REST API and imports which cannot be started using the REST API. A list of repositories is only returned for export migrations.org (string)
per_page (integer)
page (integer)
exclude (array)
post_orgs_by_org_migrationsInitiates the generation of a migration archive. Before you can use this endpoint, you must configure a blob storage provider in the 'Migrations' section in the Management Console. For more details, see 'Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloudhttps://docs.github.com/enterprise-server@3.18/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprorg (string)
data: {
. repositories (array)
. lock_repositories (boolean)
. exclude_metadata (boolean)
. exclude_git_data (boolean)
. exclude_attachments (boolean)
. exclude_releases (boolean)
. exclude_owner_projects (boolean)
. org_metadata_only (boolean)
. exclude (array)
} (object) required
get_orgs_by_org_migrations_by_migration_idFetches the status of a migration. The state of a migration can be one of the following values: pending, which means the migration hasn't started yet. exporting, which means the migration is in progress. exported, which means the migration finished successfully. failed, which means the migration failed.org (string)
migration_id (integer)
exclude (array)
get_orgs_by_org_migrations_by_migration_id_archiveFetches the URL to a migration archive.org (string)
migration_id (integer)
delete_orgs_by_org_migrations_by_migration_id_archiveDeletes a previous migration archive. Migration archives are automatically deleted after seven days.org (string)
migration_id (integer)
delete_orgs_by_org_migrations_by_migration_id_repos_by_repo_name_lockUnlocks a repository that was locked for migration. You should unlock each migrated repository and delete themhttps://docs.github.com/enterprise-server@3.18/rest/repos/repos delete-a-repository when the migration is complete and you no longer need the source data.org (string)
migration_id (integer)
repo_name (string)
get_orgs_by_org_migrations_by_migration_id_repositoriesList all the repositories for this organization migration.org (string)
migration_id (integer)
per_page (integer)
page (integer)
get_orgs_by_org_organization_fine_grained_permissionsLists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see 'Managing people's access to your organization with roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles.' To list the fine-grained permissions that can be used in custom repository roles for an organization, see 'List repository fine-grained permissions for an organizaorg (string)
get_orgs_by_org_organization_rolesLists the organization roles available in this organization. For more information on organization roles, see 'Using organization roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.' To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the organizatorg (string)
post_orgs_by_org_organization_rolesCreates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization and optionally across all repositories in the organization. For more information on custom organization roles, see 'Managing people's access to your organization with roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles.' To include repository permissions in an orgorg (string)
data: {
. name (string)
. description (string)
. permissions (array)
. base_role (string)
} (object) required
delete_orgs_by_org_organization_roles_teams_by_team_slugRemoves all assigned organization roles from a team. For more information on organization roles, see 'Using organization roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.' The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
team_slug (string)
put_orgs_by_org_organization_roles_teams_by_team_slug_by_role_idAssigns an organization role to a team in an organization. For more information on organization roles, see 'Using organization roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.' The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
team_slug (string)
role_id (integer)
delete_orgs_by_org_organization_roles_teams_by_team_slug_by_role_idRemoves an organization role from a team. For more information on organization roles, see 'Using organization roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.' The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
team_slug (string)
role_id (integer)
delete_orgs_by_org_organization_roles_users_by_usernameRevokes all assigned organization roles from a user. For more information on organization roles, see 'Using organization roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.' The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
username (string)
put_orgs_by_org_organization_roles_users_by_username_by_role_idAssigns an organization role to a member of an organization. For more information on organization roles, see 'Using organization roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.' The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
username (string)
role_id (integer)
delete_orgs_by_org_organization_roles_users_by_username_by_role_idRemove an organization role from a user. For more information on organization roles, see 'Using organization roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.' The authenticated user must be an administrator for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
username (string)
role_id (integer)
get_orgs_by_org_organization_roles_by_role_idGets an organization role that is available to this organization. For more information on organization roles, see 'Using organization roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.' To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of read_organization_custom_org_role in the orgaorg (string)
role_id (integer)
patch_orgs_by_org_organization_roles_by_role_idUpdates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see 'Managing people's access to your organization with roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles.' If the update would add repository permissions, the base_role must also be set to a value besides none, either previously or as part of the uporg (string)
role_id (integer)
data: {
. name (string)
. description (string)
. permissions (array)
. base_role (string)
} (object) required
delete_orgs_by_org_organization_roles_by_role_idDeletes a custom organization role. For more information on custom organization roles, see 'Managing people's access to your organization with roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles.' To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of write_organization_custom_orgorg (string)
role_id (integer)
get_orgs_by_org_organization_roles_by_role_id_teamsLists the teams that are assigned to an organization role. For more information on organization roles, see 'Using organization roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.' To use this endpoint, you must be an administrator for the organization. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
role_id (integer)
per_page (integer)
page (integer)
get_orgs_by_org_organization_roles_by_role_id_usersLists organization members that are assigned to an organization role. For more information on organization roles, see 'Using organization roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles.' To use this endpoint, you must be an administrator for the organization. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
role_id (integer)
per_page (integer)
page (integer)
get_orgs_by_org_outside_collaboratorsList all users who are outside collaborators of an organization.org (string)
filter (string)
per_page (integer)
page (integer)
put_orgs_by_org_outside_collaborators_by_usernameWhen 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 collaboratorhttps://docs.github.com/enterprise-server@3.18/articles/converting-an-organization-member-to-an-outside-collaborator/'. Converting an organization member to an outside collaborator may be restrictedorg (string)
username (string)
data: {
. async (boolean)
} (object) required
delete_orgs_by_org_outside_collaborators_by_usernameRemoving a user from this list will remove them from all the organization's repositories.org (string)
username (string)
get_orgs_by_org_packagesLists packages in an organization readable by the user. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'org (string)
package_type (string) required
visibility (string)
page (integer)
per_page (integer)
get_orgs_by_org_packages_by_package_type_by_package_nameGets a specific package in an organization. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'package_type (string)
package_name (string)
org (string)
delete_orgs_by_org_packages_by_package_type_by_package_nameDeletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries,package_type (string)
package_name (string)
org (string)
post_orgs_by_org_packages_by_package_type_by_package_name_restoreRestores an entire package in an organization. You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. The authentpackage_type (string)
package_name (string)
org (string)
token (string)
get_orgs_by_org_packages_by_package_type_by_package_name_versionsLists package versions for a package owned by an organization. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'package_type (string)
package_name (string)
org (string)
page (integer)
per_page (integer)
state (string)
get_orgs_by_org_packages_by_package_type_by_package_name_versions_by_package_version_idGets a specific package version in an organization. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'package_type (string)
package_name (string)
org (string)
package_version_id (integer)
delete_orgs_by_org_packages_by_package_type_by_package_name_versions_by_package_version_idDeletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. Fpackage_type (string)
package_name (string)
org (string)
package_version_id (integer)
post_orgs_by_org_packages_by_package_type_by_package_name_versions_by_package_version_id_restoreRestores a specific package version in an organization. You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. Thpackage_type (string)
package_name (string)
org (string)
package_version_id (integer)
get_orgs_by_org_personal_access_token_requestsLists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can use this endpoint.org (string)
per_page (integer)
page (integer)
sort (string)
direction (string)
owner (array)
repository (string)
permission (string)
last_used_before (string)
last_used_after (string)
token_id (array)
post_orgs_by_org_personal_access_token_requestsApproves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can use this endpoint.org (string)
data: {
. pat_request_ids (array)
. action (string)
. reason (string)
} (object) required
post_orgs_by_org_personal_access_token_requests_by_pat_request_idApproves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can use this endpoint.org (string)
pat_request_id (integer)
data: {
. action (string)
. reason (string)
} (object) required
get_orgs_by_org_personal_access_token_requests_by_pat_request_id_repositoriesLists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can use this endpoint.org (string)
pat_request_id (integer)
per_page (integer)
page (integer)
get_orgs_by_org_personal_access_tokensLists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can use this endpoint.org (string)
per_page (integer)
page (integer)
sort (string)
direction (string)
owner (array)
repository (string)
permission (string)
last_used_before (string)
last_used_after (string)
token_id (array)
post_orgs_by_org_personal_access_tokensUpdates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can use this endpoint.org (string)
data: {
. action (string)
. pat_ids (array)
} (object) required
post_orgs_by_org_personal_access_tokens_by_pat_idUpdates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can use this endpoint.org (string)
pat_id (integer)
data: {
. action (string)
} (object) required
get_orgs_by_org_personal_access_tokens_by_pat_id_repositoriesLists the repositories a fine-grained personal access token has access to. Only GitHub Apps can use this endpoint.org (string)
pat_id (integer)
per_page (integer)
page (integer)
get_orgs_by_org_pre_receive_hooksList 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.org (string)
per_page (integer)
page (integer)
direction (string)
sort (string)
get_orgs_by_org_pre_receive_hooks_by_pre_receive_hook_idGet a pre-receive hook for an organizationorg (string)
pre_receive_hook_id (integer)
patch_orgs_by_org_pre_receive_hooks_by_pre_receive_hook_idFor pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configurationorg (string)
pre_receive_hook_id (integer)
data: {
. enforcement (string)
. allow_downstream_configuration (boolean)
} (object) required
delete_orgs_by_org_pre_receive_hooks_by_pre_receive_hook_idRemoves any overrides for this hook at the org level for this org.org (string)
pre_receive_hook_id (integer)
get_orgs_by_org_private_registriesLists all private registry configurations available at the organization-level without revealing their encrypted values. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
per_page (integer)
page (integer)
post_orgs_by_org_private_registriesCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodiumhttps://libsodium.gitbook.io/doc/bindings_for_other_languages. For more information, see 'Encrypting secrets for the REST APIhttps://docs.github.com/enterprise-server@3.18/rest/guides/encrypting-secrets-for-the-rest-api.' OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
data: {
. registry_type (string)
. url (string)
. username (string)
. replaces_base (boolean)
. encrypted_value (string)
. key_id (string)
. visibility (string)
. selected_repository_ids (array)
} (object) required
get_orgs_by_org_private_registries_public_keyGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. OAuth tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
get_orgs_by_org_private_registries_by_secret_nameGet the configuration of a single private registry defined for an organization, omitting its encrypted value. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
secret_name (string)
patch_orgs_by_org_private_registries_by_secret_nameUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodiumhttps://libsodium.gitbook.io/doc/bindings_for_other_languages. For more information, see 'Encrypting secrets for the REST APIhttps://docs.github.com/enterprise-server@3.18/rest/guides/encrypting-secrets-for-the-rest-api.' OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
secret_name (string)
data: {
. registry_type (string)
. url (string)
. username (string)
. replaces_base (boolean)
. encrypted_value (string)
. key_id (string)
. visibility (string)
. selected_repository_ids (array)
} (object) required
delete_orgs_by_org_private_registries_by_secret_nameDelete a private registry configuration at the organization-level. OAuth app tokens and personal access tokens classic need the admin:org scope to use this endpoint.org (string)
secret_name (string)
get_orgs_by_org_properties_schemaGets all custom properties defined for an organization. Organization members can read these properties.org (string)
patch_orgs_by_org_properties_schemaCreates new or updates existing custom properties defined for an organization in a batch. If the property already exists, the existing property will be replaced with the new values. Missing optional values will fall back to default values, previous values will be overwritten. E.g. if a property exists with values_editable_by: org_and_repo_actors and it's updated without specifying values_editable_by, it will be updated to default value org_actors. To use this endpoint, the authenticated user morg (string)
data: {
. properties (array)
} (object) required
get_orgs_by_org_properties_schema_by_custom_property_nameGets a custom property that is defined for an organization. Organization members can read these properties.org (string)
custom_property_name (string)
put_orgs_by_org_properties_schema_by_custom_property_nameCreates a new or updates an existing custom property that is defined for an organization. To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.org (string)
custom_property_name (string)
data: {
. value_type (string)
. required (boolean)
. default_value
. description (string)
. allowed_values (array)
. values_editable_by (string)
} (object) required
delete_orgs_by_org_properties_schema_by_custom_property_nameRemoves a custom property that is defined for an organization. To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.org (string)
custom_property_name (string)
get_orgs_by_org_properties_valuesLists organization repositories with all of their custom property values. Organization members can read these properties.org (string)
per_page (integer)
page (integer)
repository_query (string)
patch_orgs_by_org_properties_valuesCreate new or update existing custom property values for repositories in a batch that belong to an organization. Each target repository will have its custom property values updated to match the values provided in the request. A maximum of 30 repositories can be updated in a single request. Using a value of null for a custom property will remove or 'unset' the property value from the repository. To use this endpoint, the authenticated user must be one of: - An administrator for the organizatorg (string)
data: {
. repository_names (array)
. properties (array)
} (object) required
get_orgs_by_org_public_membersMembers of an organization can choose to have their membership publicized or not.org (string)
per_page (integer)
page (integer)
get_orgs_by_org_public_members_by_usernameCheck if the provided user is a public member of the organization.org (string)
username (string)
put_orgs_by_org_public_members_by_usernameThe 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 methodhttps://docs.github.com/enterprise-server@3.18/rest/guides/getting-started-with-the-rest-api http-method.'org (string)
username (string)
delete_orgs_by_org_public_members_by_usernameRemoves the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.org (string)
username (string)
get_orgs_by_org_reposLists repositories for the specified organization. !NOTE In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see 'Managing security managers in your organizationhttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization.'org (string)
type (string)
sort (string)
direction (string)
per_page (integer)
page (integer)
post_orgs_by_org_reposCreates a new repository in the specified organization. The authenticated user must be a member of the organization. OAuth app tokens and personal access tokens classic need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.org (string)
data: {
. name (string)
. description (string)
. homepage (string)
. private (boolean)
. visibility (string)
. has_issues (boolean)
. has_projects (boolean)
. has_wiki (boolean)
. has_downloads (boolean)
. is_template (boolean)
. team_id (integer)
. auto_init (boolean)
. gitignore_template (string)
. license_template (string)
. allow_squash_merge (boolean)
. allow_merge_commit (boolean)
. allow_rebase_merge (boolean)
. allow_auto_merge (boolean)
. delete_branch_on_merge (boolean)
. use_squash_pr_title_as_default (boolean)
. squash_merge_commit_title (string)
. squash_merge_commit_message (string)
. merge_commit_title (string)
. merge_commit_message (string)
. custom_properties (object)
} (object) required
get_orgs_by_org_repository_fine_grained_permissionsLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see 'About custom repository roleshttps://docs.github.com/enterprise-server@3.18/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles.' The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the admorg (string)
get_orgs_by_org_rulesetsGet all the repository rulesets for an organization.org (string)
per_page (integer)
page (integer)
targets (string)
post_orgs_by_org_rulesetsCreate a repository ruleset for an organization.org (string)
data: {
. name (string)
. target (string)
. enforcement (string)
. bypass_actors (array)
. conditions (object)
. rules (array)
. source_type (string)
} (object) required
get_orgs_by_org_rulesets_rule_suitesLists suites of rule evaluations at the organization level. For more information, see 'Managing rulesets for repositories in your organizationhttps://docs.github.com/enterprise-server@3.18/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization viewing-insights-for-rulesets.'org (string)
ref (string)
repository_name (string)
time_period (string)
actor_name (string)
rule_suite_result (string)
per_page (integer)
page (integer)
get_orgs_by_org_rulesets_rule_suites_by_rule_suite_idGets information about a suite of rule evaluations from within an organization. For more information, see 'Managing rulesets for repositories in your organizationhttps://docs.github.com/enterprise-server@3.18/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization viewing-insights-for-rulesets.'org (string)
rule_suite_id (integer)
get_orgs_by_org_rulesets_by_ruleset_idGet a repository ruleset for an organization. Note: To prevent leaking sensitive information, the bypass_actors property is only returned if the user making the API request has write access to the ruleset.org (string)
ruleset_id (integer)
put_orgs_by_org_rulesets_by_ruleset_idUpdate a ruleset for an organization.org (string)
ruleset_id (integer)
data: {
. name (string)
. target (string)
. enforcement (string)
. bypass_actors (array)
. conditions (object)
. rules (array)
} (object) required
delete_orgs_by_org_rulesets_by_ruleset_idDelete a ruleset for an organization.org (string)
ruleset_id (integer)
get_orgs_by_org_secret_scanning_alertsLists secret scanning alerts for eligible repositories in an organization, from newest to oldest. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.org (string)
state (string)
secret_type (string)
resolution (string)
sort (string)
direction (string)
page (integer)
per_page (integer)
before (string)
after (string)
validity (string)
is_publicly_leaked (boolean)
is_multi_repo (boolean)
hide_secret (boolean)
get_orgs_by_org_security_managers!WARNING Closing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the 'Organization Roleshttps://docs.github.com/enterprise-server@3.18/rest/orgs/organization-roles' endpoints instead.org (string)
put_orgs_by_org_security_managers_teams_by_team_slug!WARNING Closing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the 'Organization Roleshttps://docs.github.com/enterprise-server@3.18/rest/orgs/organization-roles' endpoints instead.org (string)
team_slug (string)
delete_orgs_by_org_security_managers_teams_by_team_slug!WARNING Closing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the 'Organization Roleshttps://docs.github.com/enterprise-server@3.18/rest/orgs/organization-roles' endpoints instead.org (string)
team_slug (string)
get_orgs_by_org_settings_billing_advanced_securityGets the GitHub Advanced Security active committers for an organization per repository. Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they worg (string)
advanced_security_product (string)
per_page (integer)
page (integer)
get_orgs_by_org_teamsLists all teams in an organization that are visible to the authenticated user.org (string)
per_page (integer)
page (integer)
post_orgs_by_org_teamsTo 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 permissionshttps://docs.github.com/enterprise-server@3.18/articles/setting-team-creation-permissions-in-your-organization.' When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of morg (string)
data: {
. name (string)
. description (string)
. maintainers (array)
. repo_names (array)
. privacy (string)
. notification_setting (string)
. permission (string)
. parent_team_id (integer)
. ldap_dn (string)
} (object) required
get_orgs_by_org_teams_by_team_slugGets a team using the team's slug. To create the slug, GitHub Enterprise Server replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator. For example, 'My TEam Näme' would become my-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.org (string)
team_slug (string)
patch_orgs_by_org_teams_by_team_slugTo 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.org (string)
team_slug (string)
data: {
. name (string)
. description (string)
. privacy (string)
. notification_setting (string)
. permission (string)
. parent_team_id (integer)
} (object) required
delete_orgs_by_org_teams_by_team_slugTo 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.org (string)
team_slug (string)
get_orgs_by_org_teams_by_team_slug_discussionsList all discussions on a team's page. !NOTE You can also specify a team by org_id and team_id using the route GET /organizations/org_id/team/team_id/discussions. OAuth app tokens and personal access tokens classic need the read:discussion scope to use this endpoint.org (string)
team_slug (string)
direction (string)
per_page (integer)
page (integer)
pinned (string)
post_orgs_by_org_teams_by_team_slug_discussionsCreates a new discussion post on a team's page. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see 'Rate limits for the APIhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/rate-limits-for-the-rest-api about-secondary-rate-limits' and 'Best practices foorg (string)
team_slug (string)
data: {
. title (string)
. body (string)
. private (boolean)
} (object) required
get_orgs_by_org_teams_by_team_slug_discussions_by_discussion_numberGet a specific discussion on a team's page. !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. OAuth app tokens and personal access tokens classic need the read:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
patch_orgs_by_org_teams_by_team_slug_discussions_by_discussion_numberEdits the title and body text of a discussion post. Only the parameters you provide are updated. !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. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
data: {
. title (string)
. body (string)
} (object) required
delete_orgs_by_org_teams_by_team_slug_discussions_by_discussion_numberDelete a discussion from a team's page. !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. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
get_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_commentsList all comments on a team discussion. !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. OAuth app tokens and personal access tokens classic need the read:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
direction (string)
per_page (integer)
page (integer)
post_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_commentsCreates a new comment on a team discussion. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see 'Rate limits for the APIhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/rate-limits-for-the-rest-api about-secondary-rate-limits' and 'Best practices for usorg (string)
team_slug (string)
discussion_number (integer)
data: {
. body (string)
} (object) required
get_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_comments_by_comment_numberGet a specific comment on a team discussion. !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. OAuth app tokens and personal access tokens classic need the read:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
comment_number (integer)
patch_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_comments_by_comment_numberEdits the body text of a discussion comment. !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. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
comment_number (integer)
data: {
. body (string)
} (object) required
delete_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_comments_by_comment_numberDeletes a comment on a team discussion. !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. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
comment_number (integer)
get_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_comments_by_comment_number_reactionsList the reactions to a team discussion commenthttps://docs.github.com/enterprise-server@3.18/rest/teams/discussion-comments get-a-discussion-comment. !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. OAuth app tokens and personal access tokens classic need the read:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
comment_number (integer)
content (string)
per_page (integer)
page (integer)
post_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_comments_by_comment_number_reactionsCreate a reaction to a team discussion commenthttps://docs.github.com/enterprise-server@3.18/rest/teams/discussion-comments get-a-discussion-comment. 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. OAuth app tokens and personal access tokens classorg (string)
team_slug (string)
discussion_number (integer)
comment_number (integer)
data: {
. content (string)
} (object) required
delete_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_comments_by_comment_number_reactions_by_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 commenthttps://docs.github.com/enterprise-server@3.18/rest/teams/discussion-comments get-a-discussion-comment. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
comment_number (integer)
reaction_id (integer)
get_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_reactionsList the reactions to a team discussionhttps://docs.github.com/enterprise-server@3.18/rest/teams/discussions get-a-discussion. !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. OAuth app tokens and personal access tokens classic need the read:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
content (string)
per_page (integer)
page (integer)
post_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_reactionsCreate a reaction to a team discussionhttps://docs.github.com/enterprise-server@3.18/rest/teams/discussions get-a-discussion. 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. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
data: {
. content (string)
} (object) required
delete_orgs_by_org_teams_by_team_slug_discussions_by_discussion_number_reactions_by_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 discussionhttps://docs.github.com/enterprise-server@3.18/rest/teams/discussions get-a-discussion. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.org (string)
team_slug (string)
discussion_number (integer)
reaction_id (integer)
get_orgs_by_org_teams_by_team_slug_external_groupsLists a connection between a team and an external group. You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see 'GitHub's productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products' in the GitHub Help documentation.org (string)
team_slug (string)
patch_orgs_by_org_teams_by_team_slug_external_groupsCreates a connection between a team and an external group. Only one external group can be linked to a team. You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see 'GitHub's productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products' in the GitHub Help documentation.org (string)
team_slug (string)
data: {
. group_id (integer)
} (object) required
delete_orgs_by_org_teams_by_team_slug_external_groupsDeletes a connection between a team and an external group. You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.org (string)
team_slug (string)
get_orgs_by_org_teams_by_team_slug_membersTeam members will include the members of child teams. To list members in a team, the team must be visible to the authenticated user.org (string)
team_slug (string)
role (string)
per_page (integer)
page (integer)
get_orgs_by_org_teams_by_team_slug_memberships_by_usernameTeam 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 Create a teamhttps://docs.githorg (string)
team_slug (string)
username (string)
put_orgs_by_org_teams_by_team_slug_memberships_by_usernameAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. !NOTE When you have team synchronization set up for a team with your organization's identity provider Iorg (string)
team_slug (string)
username (string)
data: {
. role (string)
} (object) required
delete_orgs_by_org_teams_by_team_slug_memberships_by_usernameTo 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. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-org (string)
team_slug (string)
username (string)
get_orgs_by_org_teams_by_team_slug_projects!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.org (string)
team_slug (string)
per_page (integer)
page (integer)
get_orgs_by_org_teams_by_team_slug_projects_by_project_id!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.org (string)
team_slug (string)
project_id (integer)
put_orgs_by_org_teams_by_team_slug_projects_by_project_id!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.org (string)
team_slug (string)
project_id (integer)
data: {
. permission (string)
} (object) required
delete_orgs_by_org_teams_by_team_slug_projects_by_project_id!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.org (string)
team_slug (string)
project_id (integer)
get_orgs_by_org_teams_by_team_slug_reposLists 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.org (string)
team_slug (string)
per_page (integer)
page (integer)
get_orgs_by_org_teams_by_team_slug_repos_by_owner_by_repoChecks 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 typehttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types/ via the application/vnd.github.v3.repository+json accept header. Iorg (string)
team_slug (string)
owner (string)
repo (string)
put_orgs_by_org_teams_by_team_slug_repos_by_owner_by_repoTo 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-Lorg (string)
team_slug (string)
owner (string)
repo (string)
data: {
. permission (string)
} (object) required
delete_orgs_by_org_teams_by_team_slug_repos_by_owner_by_repoIf 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.org (string)
team_slug (string)
owner (string)
repo (string)
get_orgs_by_org_teams_by_team_slug_teamsLists 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.org (string)
team_slug (string)
per_page (integer)
page (integer)
post_orgs_by_org_by_security_product_by_enablement!WARNING Closing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurationshttps://docs.github.com/enterprise-server@3.18/rest/code-security/configurations instead. For more information, see the changeloghttps://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/. Enables or disables the specified security featureorg (string)
security_product (string)
enablement (string)
data (undefined) required
get_projects_columns_by_column_id!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.column_id (integer)
patch_projects_columns_by_column_id!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.column_id (integer)
data: {
. name (string)
} (object) required
delete_projects_columns_by_column_id!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.column_id (integer)
post_projects_columns_by_column_id_moves!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.column_id (integer)
data: {
. position (string)
} (object) required
get_projects_by_project_id_collaborators!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.project_id (integer)
affiliation (string)
per_page (integer)
page (integer)
put_projects_by_project_id_collaborators_by_username!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.project_id (integer)
username (string)
data: {
. permission (string)
} (object) required
delete_projects_by_project_id_collaborators_by_username!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.project_id (integer)
username (string)
get_projects_by_project_id_collaborators_by_username_permission!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.project_id (integer)
username (string)
get_rate_limit!NOTE Accessing this endpoint does not count against your REST API rate limit. Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories: The core object provides your rate limit status for all non-search-related resources in the REST API. The search object provides your rate limit statusNo parameters
get_repos_by_owner_by_repoThe 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. !NOTE - In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see 'Managing security managers in your organizationhttps://docs.github.com/enterprise-servowner (string)
repo (string)
patch_repos_by_owner_by_repoNote: To edit a repository's topics, use the Replace all repository topicshttps://docs.github.com/enterprise-server@3.18/rest/repos/repos replace-all-repository-topics endpoint.owner (string)
repo (string)
data: {
. name (string)
. description (string)
. homepage (string)
. private (boolean)
. visibility (string)
. security_and_analysis (object)
. has_issues (boolean)
. has_projects (boolean)
. has_wiki (boolean)
. is_template (boolean)
. default_branch (string)
. allow_squash_merge (boolean)
. allow_merge_commit (boolean)
. allow_rebase_merge (boolean)
. delete_branch_on_merge (boolean)
. allow_update_branch (boolean)
. use_squash_pr_title_as_default (boolean)
. squash_merge_commit_title (string)
. squash_merge_commit_message (string)
. merge_commit_title (string)
. merge_commit_message (string)
. archived (boolean)
. allow_forking (boolean)
. web_commit_signoff_required (boolean)
} (object) required
delete_repos_by_owner_by_repoDeleting a repository requires admin access. If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, you will get a 403 Forbidden response. OAuth app tokens and personal access tokens classic need the delete_repo scope to use this endpoint.owner (string)
repo (string)
get_repos_by_owner_by_repo_actions_artifactsLists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
per_page (integer)
page (integer)
name (string)
get_repos_by_owner_by_repo_actions_artifacts_by_artifact_idGets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
artifact_id (integer)
delete_repos_by_owner_by_repo_actions_artifacts_by_artifact_idDeletes an artifact for a workflow run. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
artifact_id (integer)
get_repos_by_owner_by_repo_actions_artifacts_by_artifact_id_by_archive_formatGets 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. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
artifact_id (integer)
archive_format (string)
get_repos_by_owner_by_repo_actions_cache_usageGets GitHub Actions cache usage for a repository. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
get_repos_by_owner_by_repo_actions_cache_usage_policyGets GitHub Actions cache usage policy for a repository. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
patch_repos_by_owner_by_repo_actions_cache_usage_policySets GitHub Actions cache usage policy for a repository. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
data: {
. repo_cache_size_limit_in_gb (integer)
} (object) required
get_repos_by_owner_by_repo_actions_cachesLists the GitHub Actions caches for a repository. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
per_page (integer)
page (integer)
ref (string)
key (string)
sort (string)
direction (string)
delete_repos_by_owner_by_repo_actions_cachesDeletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
key (string) required
ref (string)
delete_repos_by_owner_by_repo_actions_caches_by_cache_idDeletes a GitHub Actions cache for a repository, using a cache ID. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
cache_id (integer)
get_repos_by_owner_by_repo_actions_jobs_by_job_idGets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
job_id (integer)
get_repos_by_owner_by_repo_actions_jobs_by_job_id_logsGets 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, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
job_id (integer)
post_repos_by_owner_by_repo_actions_jobs_by_job_id_rerunRe-run a job and its dependent jobs in a workflow run. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
job_id (integer)
data: {
. enable_debug_logging (boolean)
} (object) required
get_repos_by_owner_by_repo_actions_oidc_customization_subGets the customization template for an OpenID Connect OIDC subject claim. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
put_repos_by_owner_by_repo_actions_oidc_customization_subSets the customization template and opt-in or opt-out flag for an OpenID Connect OIDC subject claim for a repository. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
data: {
. use_default (boolean)
. include_claim_keys (array)
} (object) required
get_repos_by_owner_by_repo_actions_organization_secretsLists all organization secrets shared with a repository without revealing their encrypted values. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_actions_organization_variablesLists all organization variables shared with a repository. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_actions_permissionsGets 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.owner (string)
repo (string)
put_repos_by_owner_by_repo_actions_permissionsSets 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. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
data: {
. enabled (boolean)
. allowed_actions (string)
} (object) required
get_repos_by_owner_by_repo_actions_permissions_accessGets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. For more information, see 'Allowing access to components in a private repositoryhttps://docs.github.com/enterprise-server@3.18/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository allowing-access-to-components-in-a-owner (string)
repo (string)
put_repos_by_owner_by_repo_actions_permissions_accessSets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. This endpoint only applies to internal and private repositories. For more information, see 'Allowing access to components in a private repositoryhttps://docs.github.com/enterprise-server@3.18/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository allowing-access-to-components-in-a-owner (string)
repo (string)
data: {
. access_level (string)
} (object) required
get_repos_by_owner_by_repo_actions_permissions_selected_actionsGets 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 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.owner (string)
repo (string)
put_repos_by_owner_by_repo_actions_permissions_selected_actionsSets 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 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_alowner (string)
repo (string)
data: {
. github_owned_allowed (boolean)
. verified_allowed (boolean)
. patterns_allowed (array)
} (object) required
get_repos_by_owner_by_repo_actions_permissions_workflowGets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, as well as if GitHub Actions can submit approving pull request reviews. For more information, see 'Setting the permissions of the GITHUB_TOKEN for your repositoryhttps://docs.github.com/enterprise-server@3.18/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository setting-the-permissions-of-the-githuowner (string)
repo (string)
put_repos_by_owner_by_repo_actions_permissions_workflowSets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions can submit approving pull request reviews. For more information, see 'Setting the permissions of the GITHUB_TOKEN for your repositoryhttps://docs.github.com/enterprise-server@3.18/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository setting-the-permissions-of-the-github_owner (string)
repo (string)
data: {
. default_workflow_permissions
. can_approve_pull_request_reviews
} (object) required
get_repos_by_owner_by_repo_actions_runnersLists all self-hosted runners configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
name (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_actions_runners_downloadsLists binaries for the runner application that you can download and run. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
post_repos_by_owner_by_repo_actions_runners_generate_jitconfigGenerates a configuration that can be passed to the runner application at startup. The authenticated user must have admin access to the repository. OAuth tokens and personal access tokens classic need therepo scope to use this endpoint.owner (string)
repo (string)
data: {
. name (string)
. runner_group_id (integer)
. labels (array)
. work_folder (string)
} (object) required
post_repos_by_owner_by_repo_actions_runners_registration_tokenReturns a token that you can pass to the config script. The token expires after one hour. For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner: ./config.sh --url https://github.com/octo-org --token TOKEN Authenticated users must have admin access to the repository to use this endpoint. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
post_repos_by_owner_by_repo_actions_runners_remove_tokenReturns a token that you can pass to the config script to remove a self-hosted runner from an repository. The token expires after one hour. For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: ./config.sh remove --token TOKEN Authenticated users must have admin access to the repository to use this endpoint. OAuth tokens and personal access tokens classic need the repo scopeowner (string)
repo (string)
get_repos_by_owner_by_repo_actions_runners_by_runner_idGets a specific self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
runner_id (integer)
delete_repos_by_owner_by_repo_actions_runners_by_runner_idForces 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. Authenticated users must have admin access to the repository to use this endpoint. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
runner_id (integer)
get_repos_by_owner_by_repo_actions_runners_by_runner_id_labelsLists all labels for a self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
runner_id (integer)
post_repos_by_owner_by_repo_actions_runners_by_runner_id_labelsAdds custom labels to a self-hosted runner configured in a repository. Authenticated users must have admin access to the organization to use this endpoint. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
runner_id (integer)
data: {
. labels (array)
} (object) required
put_repos_by_owner_by_repo_actions_runners_by_runner_id_labelsRemove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
runner_id (integer)
data: {
. labels (array)
} (object) required
delete_repos_by_owner_by_repo_actions_runners_by_runner_id_labelsRemove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
runner_id (integer)
delete_repos_by_owner_by_repo_actions_runners_by_runner_id_labels_by_nameRemove a custom label from a self-hosted runner configured in a repository. Returns the remaining labels from the runner. This endpoint returns a 404 Not Found status if the custom label is not present on the runner. Authenticated users must have admin access to the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
runner_id (integer)
name (string)
get_repos_by_owner_by_repo_actions_runsLists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parametershttps://docs.github.com/enterprise-server@3.18/rest/guides/getting-started-with-the-rest-api parameters. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository. This endpoint will return up to 1,000 results for eaowner (string)
repo (string)
actor (string)
branch (string)
event (string)
status (string)
per_page (integer)
page (integer)
created (string)
exclude_pull_requests (boolean)
check_suite_id (integer)
head_sha (string)
get_repos_by_owner_by_repo_actions_runs_by_run_idGets a specific workflow run. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
run_id (integer)
exclude_pull_requests (boolean)
delete_repos_by_owner_by_repo_actions_runs_by_run_idDeletes a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is private, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
run_id (integer)
get_repos_by_owner_by_repo_actions_runs_by_run_id_approvalsAnyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
run_id (integer)
get_repos_by_owner_by_repo_actions_runs_by_run_id_artifactsLists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
run_id (integer)
per_page (integer)
page (integer)
name (string)
get_repos_by_owner_by_repo_actions_runs_by_run_id_attempts_by_attempt_numberGets a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
run_id (integer)
attempt_number (integer)
exclude_pull_requests (boolean)
get_repos_by_owner_by_repo_actions_runs_by_run_id_attempts_by_attempt_number_jobsLists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information about using parameters, see Parametershttps://docs.github.com/enterprise-server@3.18/rest/guides/getting-started-with-the-rest-api parameters. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
run_id (integer)
attempt_number (integer)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_actions_runs_by_run_id_attempts_by_attempt_number_logsGets a redirect URL to download an archive of log files for a specific workflow run attempt. 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, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
run_id (integer)
attempt_number (integer)
post_repos_by_owner_by_repo_actions_runs_by_run_id_cancelCancels a workflow run using its id. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
run_id (integer)
post_repos_by_owner_by_repo_actions_runs_by_run_id_deployment_protection_ruleApprove or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see 'Using environments for deploymenthttps://docs.github.com/enterprise-server@3.18/actions/deployment/targeting-different-environments/using-environments-for-deployment.' !NOTE GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/owner/rowner (string)
repo (string)
run_id (integer)
data (undefined) required
post_repos_by_owner_by_repo_actions_runs_by_run_id_force_cancelCancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an always condition on a job. You should only use this endpoint to cancel a workflow run when the workflow run is not responding to POST /repos/owner/repo/actions/runs/run_id/cancel/rest/actions/workflow-runs cancel-a-workflow-run. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
run_id (integer)
get_repos_by_owner_by_repo_actions_runs_by_run_id_jobsLists jobs for a workflow run. You can use parameters to narrow the list of results. For more information about using parameters, see Parametershttps://docs.github.com/enterprise-server@3.18/rest/guides/getting-started-with-the-rest-api parameters. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
run_id (integer)
filter (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_actions_runs_by_run_id_logsGets 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, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
run_id (integer)
delete_repos_by_owner_by_repo_actions_runs_by_run_id_logsDeletes all logs for a workflow run. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
run_id (integer)
get_repos_by_owner_by_repo_actions_runs_by_run_id_pending_deploymentsGet 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, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
run_id (integer)
post_repos_by_owner_by_repo_actions_runs_by_run_id_pending_deploymentsApprove or reject pending deployments that are waiting on approval by a required reviewer. Required reviewers with read access to the repository contents and deployments can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
run_id (integer)
data: {
. environment_ids (array)
. state (string)
. comment (string)
} (object) required
post_repos_by_owner_by_repo_actions_runs_by_run_id_rerunRe-runs your workflow run using its id. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
run_id (integer)
data: {
. enable_debug_logging (boolean)
} (object) required
post_repos_by_owner_by_repo_actions_runs_by_run_id_rerun_failed_jobsRe-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
run_id (integer)
data: {
. enable_debug_logging (boolean)
} (object) required
get_repos_by_owner_by_repo_actions_secretsLists all secrets available in a repository without revealing their encrypted values. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_actions_secrets_public_keyGets 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, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
get_repos_by_owner_by_repo_actions_secrets_by_secret_nameGets a single repository secret without revealing its encrypted value. The authenticated user must have collaborator access to the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
secret_name (string)
put_repos_by_owner_by_repo_actions_secrets_by_secret_nameCreates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodiumhttps://libsodium.gitbook.io/doc/bindings_for_other_languages. For more information, see 'Encrypting secrets for the REST APIhttps://docs.github.com/enterprise-server@3.18/rest/guides/encrypting-secrets-for-the-rest-api.' Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens classic need the repo scope to useowner (string)
repo (string)
secret_name (string)
data: {
. encrypted_value (string)
. key_id (string)
} (object) required
delete_repos_by_owner_by_repo_actions_secrets_by_secret_nameDeletes a secret in a repository using the secret name. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
secret_name (string)
get_repos_by_owner_by_repo_actions_variablesLists all repository variables. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_actions_variablesCreates a repository variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
data: {
. name (string)
. value (string)
} (object) required
get_repos_by_owner_by_repo_actions_variables_by_nameGets a specific variable in a repository. The authenticated user must have collaborator access to the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
name (string)
patch_repos_by_owner_by_repo_actions_variables_by_nameUpdates a repository variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
name (string)
data: {
. name (string)
. value (string)
} (object) required
delete_repos_by_owner_by_repo_actions_variables_by_nameDeletes a repository variable using the variable name. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
name (string)
get_repos_by_owner_by_repo_actions_workflowsLists the workflows in a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_actions_workflows_by_workflow_idGets 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. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
workflow_id (undefined)
put_repos_by_owner_by_repo_actions_workflows_by_workflow_id_disableDisables 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. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
workflow_id (undefined)
post_repos_by_owner_by_repo_actions_workflows_by_workflow_id_dispatchesYou 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/developers/webhooks-and-events/webhook-events-and-payloads workflow_dispatch 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, seeowner (string)
repo (string)
workflow_id (undefined)
data: {
. ref (string)
. inputs (object)
} (object) required
put_repos_by_owner_by_repo_actions_workflows_by_workflow_id_enableEnables 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. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
workflow_id (undefined)
get_repos_by_owner_by_repo_actions_workflows_by_workflow_id_runsList 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 Parametershttps://docs.github.com/enterprise-server@3.18/rest/guides/getting-started-with-the-rest-api parameters. Anyone with read access to the repository can use this endpoint OAuth app tokens and personal access tokens classic need the repo scope to use thiowner (string)
repo (string)
workflow_id (undefined)
actor (string)
branch (string)
event (string)
status (string)
per_page (integer)
page (integer)
created (string)
exclude_pull_requests (boolean)
check_suite_id (integer)
head_sha (string)
get_repos_by_owner_by_repo_activityLists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. For more information about viewing repository activity, see 'Viewing activity and data for your repositoryhttps://docs.github.com/enterprise-server@3.18/repositories/viewing-activity-and-data-for-your-repository.'owner (string)
repo (string)
direction (string)
per_page (integer)
before (string)
after (string)
ref (string)
actor (string)
time_period (string)
activity_type (string)
get_repos_by_owner_by_repo_assigneesLists the available assigneeshttps://docs.github.com/enterprise-server@3.18/articles/assigning-issues-and-pull-requests-to-other-github-users/ for issues in a repository.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_assignees_by_assigneeChecks 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.owner (string)
repo (string)
assignee (string)
get_repos_by_owner_by_repo_autolinksGets all autolinks that are configured for a repository. Information about autolinks are only available to repository administrators.owner (string)
repo (string)
post_repos_by_owner_by_repo_autolinksUsers with admin access to the repository can create an autolink.owner (string)
repo (string)
data: {
. key_prefix (string)
. url_template (string)
. is_alphanumeric (boolean)
} (object) required
get_repos_by_owner_by_repo_autolinks_by_autolink_idThis returns a single autolink reference by ID that was configured for the given repository. Information about autolinks are only available to repository administrators.owner (string)
repo (string)
autolink_id (integer)
delete_repos_by_owner_by_repo_autolinks_by_autolink_idThis deletes a single autolink reference by ID that was configured for the given repository. Information about autolinks are only available to repository administrators.owner (string)
repo (string)
autolink_id (integer)
get_repos_by_owner_by_repo_automated_security_fixesShows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see 'Configuring Dependabot security updateshttps://docs.github.com/enterprise-server@3.18/articles/configuring-automated-security-fixes'.owner (string)
repo (string)
get_repos_by_owner_by_repo_branchesList branchesowner (string)
repo (string)
protected (boolean)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_branches_by_branchGet a branchowner (string)
repo (string)
branch (string)
get_repos_by_owner_by_repo_branches_by_branch_protectionProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
put_repos_by_owner_by_repo_branches_by_branch_protectionProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Protecting a branch requires admin or owner permissions to the repository. !NOTE Passingowner (string)
repo (string)
branch (string)
data: {
. required_status_checks (object)
. enforce_admins (boolean)
. required_pull_request_reviews (object)
. restrictions (object)
. required_linear_history (boolean)
. allow_force_pushes (boolean)
. allow_deletions (boolean)
. block_creations (boolean)
. required_conversation_resolution (boolean)
. lock_branch (boolean)
. allow_fork_syncing (boolean)
} (object) required
delete_repos_by_owner_by_repo_branches_by_branch_protectionProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
get_repos_by_owner_by_repo_branches_by_branch_protection_enforce_adminsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
post_repos_by_owner_by_repo_branches_by_branch_protection_enforce_adminsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Adding admin enforcement requires admin or owner permissions to the repository and branch powner (string)
repo (string)
branch (string)
delete_repos_by_owner_by_repo_branches_by_branch_protection_enforce_adminsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Removing admin enforcement requires admin or owner permissions to the repository and branchowner (string)
repo (string)
branch (string)
get_repos_by_owner_by_repo_branches_by_branch_protection_required_pull_request_reviewsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
patch_repos_by_owner_by_repo_branches_by_branch_protection_required_pull_request_reviewsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Updating pull request review enforcement requires admin or owner permissions to the repositowner (string)
repo (string)
branch (string)
data: {
. dismissal_restrictions (object)
. dismiss_stale_reviews (boolean)
. require_code_owner_reviews (boolean)
. required_approving_review_count (integer)
. require_last_push_approval (boolean)
. bypass_pull_request_allowances (object)
} (object) required
delete_repos_by_owner_by_repo_branches_by_branch_protection_required_pull_request_reviewsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
get_repos_by_owner_by_repo_branches_by_branch_protection_required_signaturesProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpowner (string)
repo (string)
branch (string)
post_repos_by_owner_by_repo_branches_by_branch_protection_required_signaturesProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpowner (string)
repo (string)
branch (string)
delete_repos_by_owner_by_repo_branches_by_branch_protection_required_signaturesProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. When authenticated with admin or owner permissions to the repository, you can use this endpowner (string)
repo (string)
branch (string)
get_repos_by_owner_by_repo_branches_by_branch_protection_required_status_checksProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
patch_repos_by_owner_by_repo_branches_by_branch_protection_required_status_checksProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Updating required status checks requires admin or owner permissions to the repository and bowner (string)
repo (string)
branch (string)
data: {
. strict (boolean)
. contexts (array)
. checks (array)
} (object) required
delete_repos_by_owner_by_repo_branches_by_branch_protection_required_status_checksProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
get_repos_by_owner_by_repo_branches_by_branch_protection_required_status_checks_contextsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
post_repos_by_owner_by_repo_branches_by_branch_protection_required_status_checks_contextsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
data (undefined) required
put_repos_by_owner_by_repo_branches_by_branch_protection_required_status_checks_contextsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
data (undefined) required
delete_repos_by_owner_by_repo_branches_by_branch_protection_required_status_checks_contextsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation.owner (string)
repo (string)
branch (string)
data (undefined) required
get_repos_by_owner_by_repo_branches_by_branch_protection_restrictionsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Lists who has access to this protected branch. !NOTE Users, apps, and teams restrictionsowner (string)
repo (string)
branch (string)
delete_repos_by_owner_by_repo_branches_by_branch_protection_restrictionsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Disables the ability to restrict who can push to this branch.owner (string)
repo (string)
branch (string)
get_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_appsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are instaowner (string)
repo (string)
branch (string)
post_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_appsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Grants the specified apps push access for this branch. Only GitHub Apps that are installedowner (string)
repo (string)
branch (string)
data: {
. apps (array)
} (object) required
put_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_appsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Replaces the list of apps that have push access to this branch. This removes all apps thatowner (string)
repo (string)
branch (string)
data: {
. apps (array)
} (object) required
delete_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_appsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Removes the ability of an app to push to this branch. Only GitHub Apps that are installed oowner (string)
repo (string)
branch (string)
data: {
. apps (array)
} (object) required
get_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_teamsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Lists the teams who have push access to this branch. The list includes child teams.owner (string)
repo (string)
branch (string)
post_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_teamsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Grants the specified teams push access for this branch. You can also give push access to chowner (string)
repo (string)
branch (string)
data (undefined) required
put_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_teamsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Replaces the list of teams that have push access to this branch. This removes all teams thaowner (string)
repo (string)
branch (string)
data (undefined) required
delete_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_teamsProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Removes the ability of a team to push to this branch. You can also remove push access for cowner (string)
repo (string)
branch (string)
data (undefined) required
get_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_usersProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Lists the people who have push access to this branch.owner (string)
repo (string)
branch (string)
post_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_usersProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Grants the specified people push access for this branch. | Type | Descriptionowner (string)
repo (string)
branch (string)
data: {
. users (array)
} (object) required
put_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_usersProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Replaces the list of people that have push access to this branch. This removes all people towner (string)
repo (string)
branch (string)
data: {
. users (array)
} (object) required
delete_repos_by_owner_by_repo_branches_by_branch_protection_restrictions_usersProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Removes the ability of a user to push to this branch. | Type | Descriptionowner (string)
repo (string)
branch (string)
data: {
. users (array)
} (object) required
post_repos_by_owner_by_repo_branches_by_branch_renameRenames 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 branchhttps://docs.github.com/enterprise-server@3.18/github/administering-a-repository/renaming-a-branch'. The authenticated user must have push access to the branch. If the branch is the default branch, towner (string)
repo (string)
branch (string)
data: {
. new_name (string)
} (object) required
get_repos_by_owner_by_repo_bypass_requests_push_rulesLists the requests made by users of a repository to bypass push protection rulesowner (string)
repo (string)
reviewer (string)
requester (string)
time_period (string)
request_status (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_bypass_requests_push_rules_by_bypass_request_numberGet information about a request to bypass push protection rules for a repository.owner (string)
repo (string)
bypass_request_number (integer)
get_repos_by_owner_by_repo_bypass_requests_secret_scanningLists requests to bypass secret scanning push protection in a repository. Delegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint. Personal access tokens classic need the security_events scope to use this endpoint.owner (string)
repo (string)
reviewer (string)
requester (string)
time_period (string)
request_status (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_bypass_requests_secret_scanning_by_bypass_request_numberGets a specific request to bypass secret scanning push protection in a repository. Delegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint. Personal access tokens classic need the security_events scope to use this endpoint.owner (string)
repo (string)
bypass_request_number (integer)
patch_repos_by_owner_by_repo_bypass_requests_secret_scanning_by_bypass_request_numberApprove or deny a request to bypass secret scanning push protection in a repository. Delegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint. Personal access tokens classic need the security_events scope to use this endpoint.owner (string)
repo (string)
bypass_request_number (integer)
data: {
. status (string)
. message (string)
} (object) required
delete_repos_by_owner_by_repo_bypass_responses_secret_scanning_by_bypass_response_idDissmiss a response given to a bypass request for secret scanning push protection in a repository. Delegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint. Personal access tokens classic need the security_events scope to use this endpoint.owner (string)
repo (string)
bypass_response_id (integer)
post_repos_by_owner_by_repo_check_runsCreates a new check run for a specific commit in a repository. To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. 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. !NOTE The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branchowner (string)
repo (string)
data: {
. name (string)
. head_sha (string)
. details_url (string)
. external_id (string)
. status (string)
. started_at (string)
. conclusion (string)
. completed_at (string)
. output (object)
. actions (array)
} (object) required
get_repos_by_owner_by_repo_check_runs_by_check_run_idGets a single check run using its 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. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint on a private repository.owner (string)
repo (string)
check_run_id (integer)
patch_repos_by_owner_by_repo_check_runs_by_check_run_idUpdates a check run for a specific commit in a repository. !NOTE The endpoints to manage checks only look 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. OAuth apps and personal access tokens classic cannot use this endpoint.owner (string)
repo (string)
check_run_id (integer)
data: {
. name (string)
. details_url (string)
. external_id (string)
. started_at (string)
. status (string)
. conclusion (string)
. completed_at (string)
. output (object)
. actions (array)
} (object) required
get_repos_by_owner_by_repo_check_runs_by_check_run_id_annotationsLists annotations for a check run using the annotation id. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint on a private repository.owner (string)
repo (string)
check_run_id (integer)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_check_runs_by_check_run_id_rerequestTriggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhookhttps://docs.github.com/enterprise-server@3.18/webhooks/event-payloads/ check_run event with the action rerequested. When a check run is rerequested, the status of the check suite it belongs to is reset to queued and the conclusion is cleared. The check run itself is not updated. GitHub apps recieving the check_run webhookhttps://docs.github.com/enterpriseowner (string)
repo (string)
check_run_id (integer)
post_repos_by_owner_by_repo_check_suitesCreates a check suite manually. By default, check suites are automatically created when you create a check runhttps://docs.github.com/enterprise-server@3.18/rest/checks/runs. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using 'Update repository preferences for check suiteshttps://docs.github.com/enterprise-server@3.18/rest/checks/suites update-repository-preferences-for-check-suites'. !NOTE The Checks API only looks for pushes iowner (string)
repo (string)
data: {
. head_sha (string)
} (object) required
patch_repos_by_owner_by_repo_check_suites_preferencesChanges 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 suitehttps://docs.github.com/enterprise-server@3.18/rest/checks/suites create-a-check-suite. You must have admin permissions in the repository to set preferences for check suites.owner (string)
repo (string)
data: {
. auto_trigger_checks (array)
} (object) required
get_repos_by_owner_by_repo_check_suites_by_check_suite_idGets a single check suite using its 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. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint on a private repository.owner (string)
repo (string)
check_suite_id (integer)
get_repos_by_owner_by_repo_check_suites_by_check_suite_id_check_runsLists check runs for a check suite using its id. !NOTE The endpoints to manage checks only look 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. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint on a private repository.owner (string)
repo (string)
check_suite_id (integer)
check_name (string)
status (string)
filter (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_check_suites_by_check_suite_id_rerequestTriggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhookhttps://docs.github.com/enterprise-server@3.18/webhooks/event-payloads/ check_suite event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.owner (string)
repo (string)
check_suite_id (integer)
get_repos_by_owner_by_repo_code_scanning_alertsLists code scanning alerts. 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. OAuth app tokens and personal access tokens classic need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.owner (string)
repo (string)
tool_name (undefined)
tool_guid (undefined)
page (integer)
per_page (integer)
ref (undefined)
pr (integer)
direction (string)
before (string)
after (string)
sort (string)
state (string)
severity (string)
get_repos_by_owner_by_repo_code_scanning_alerts_by_alert_numberGets a single code scanning alert. OAuth app tokens and personal access tokens classic need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.owner (string)
repo (string)
alert_number (undefined)
patch_repos_by_owner_by_repo_code_scanning_alerts_by_alert_numberUpdates the status of a single code scanning alert. OAuth app tokens and personal access tokens classic need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.owner (string)
repo (string)
alert_number (undefined)
data: {
. state (string)
. dismissed_reason (string)
. dismissed_comment (string)
} (object) required
get_repos_by_owner_by_repo_code_scanning_alerts_by_alert_number_instancesLists all instances of the specified code scanning alert. OAuth app tokens and personal access tokens classic need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.owner (string)
repo (string)
alert_number (undefined)
page (integer)
per_page (integer)
ref (undefined)
pr (integer)
get_repos_by_owner_by_repo_code_scanning_analysesLists 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. !WARNING Closing down notice: The tool_name field is closingowner (string)
repo (string)
tool_name (undefined)
tool_guid (undefined)
page (integer)
per_page (integer)
pr (integer)
ref (string)
sarif_id (string)
direction (string)
sort (string)
get_repos_by_owner_by_repo_code_scanning_analyses_by_analysis_idGets a specified code scanning analysis for a repository. 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. This endpointowner (string)
repo (string)
analysis_id (integer)
delete_repos_by_owner_by_repo_code_scanning_analyses_by_analysis_idDeletes a specified code scanning analysis from a repository. 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. When you list the analyses for a repository, one or more will be identified as deletable in the response: 'deletable': true An analysis is deletable when it's the most recent in a set of analyses. Typically, a repository will havowner (string)
repo (string)
analysis_id (integer)
confirm_delete (string)
get_repos_by_owner_by_repo_code_scanning_default_setupGets a code scanning default setup configuration. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.owner (string)
repo (string)
patch_repos_by_owner_by_repo_code_scanning_default_setupUpdates a code scanning default setup configuration. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.owner (string)
repo (string)
data: {
. state (string)
. runner_type (string)
. runner_label (string)
. query_suite (string)
. threat_model (string)
. languages (array)
} (object) required
post_repos_by_owner_by_repo_code_scanning_sarifsUploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see 'Troubleshooting SARIF uploadshttps://docs.github.com/enterprise-server@3.18/code-security/code-scanning/troubleshooting-sarif.' 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 requesowner (string)
repo (string)
data: {
. commit_sha (string)
. ref (string)
. sarif (string)
. checkout_uri (string)
. started_at (string)
. tool_name (string)
} (object) required
get_repos_by_owner_by_repo_code_scanning_sarifs_by_sarif_idGets 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/rest/code-scanning/code-scanning get-a-code-scanning-analysis-for-a-repository.' OAuth app tokens and personal access tokens classic need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint witowner (string)
repo (string)
sarif_id (string)
get_repos_by_owner_by_repo_code_security_configurationGet the code security configuration that manages a repository's code security settings. The authenticated user must be an administrator or security manager for the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
get_repos_by_owner_by_repo_codeowners_errorsList any syntax errors that are detected in the CODEOWNERS file. For more information about the correct CODEOWNERS syntax, see 'About code ownershttps://docs.github.com/enterprise-server@3.18/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.'owner (string)
repo (string)
ref (string)
get_repos_by_owner_by_repo_collaboratorsFor 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. The permissions hash returned in the response contains the base role permissions of the collaborator. The role_name is the highest role assigned to the collaborator after considering all sourcesowner (string)
repo (string)
affiliation (string)
permission (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_collaborators_by_usernameFor 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. The authenticated user must have push access to the repository to use this endpoint. OAuth app tokens and personal access tokens classicowner (string)
repo (string)
username (string)
put_repos_by_owner_by_repo_collaborators_by_usernameThis endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see 'Rate limits for the APIhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/rate-limits-for-the-rest-api about-secondary-rate-limits' and 'Best practices for using the REST APIhttps://docs.github.com/enterowner (string)
repo (string)
username (string)
data: {
. permission (string)
} (object) required
delete_repos_by_owner_by_repo_collaborators_by_usernameRemoves a collaborator from a repository. To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. This endpoint also: - Cancels any outstanding invitations sent by the collaborator - Unassigns the user from any issues - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - Unstars the repository - Updates access permissions toowner (string)
repo (string)
username (string)
get_repos_by_owner_by_repo_collaborators_by_username_permissionChecks the repository permission and role of a collaborator. The permission attribute provides the legacy base roles of admin, write, read, and none, where the maintain role is mapped to write and the triage role is mapped to read. The role_name attribute provides the name of the assigned role, including custom roles. The permission can also be used to determine which base level of access the collaborator has to the repository. The calculated permissions are the highest role assigned to the coowner (string)
repo (string)
username (string)
get_repos_by_owner_by_repo_commentsLists the commit comments for a specified repository. Comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.giowner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_comments_by_comment_idGets a specified commit comment. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representowner (string)
repo (string)
comment_id (integer)
patch_repos_by_owner_by_repo_comments_by_comment_idUpdates the contents of a specified commit comment. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns aowner (string)
repo (string)
comment_id (integer)
data: {
. body (string)
} (object) required
delete_repos_by_owner_by_repo_comments_by_comment_idDelete a commit commentowner (string)
repo (string)
comment_id (integer)
get_repos_by_owner_by_repo_comments_by_comment_id_reactionsList the reactions to a commit commenthttps://docs.github.com/enterprise-server@3.18/rest/commits/comments get-a-commit-comment.owner (string)
repo (string)
comment_id (integer)
content (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_comments_by_comment_id_reactionsCreate a reaction to a commit commenthttps://docs.github.com/enterprise-server@3.18/rest/commits/comments get-a-commit-comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.owner (string)
repo (string)
comment_id (integer)
data: {
. content (string)
} (object) required
delete_repos_by_owner_by_repo_comments_by_comment_id_reactions_by_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 commenthttps://docs.github.com/enterprise-server@3.18/rest/commits/comments get-a-commit-comment.owner (string)
repo (string)
comment_id (integer)
reaction_id (integer)
get_repos_by_owner_by_repo_commitsSignature 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: | Name | Type | Description | | ---- | ---- | ----------- | | verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. | | reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. | | signatureowner (string)
repo (string)
sha (string)
path (string)
author (string)
committer (string)
since (string)
until (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_commits_by_commit_sha_branches_where_headProtected 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Returns all branches where the given commit SHA is the HEAD, or latest commit for the brancowner (string)
repo (string)
commit_sha (string)
get_repos_by_owner_by_repo_commits_by_commit_sha_commentsLists the comments for a specified commit. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text onlyowner (string)
repo (string)
commit_sha (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_commits_by_commit_sha_commentsCreate a comment for a commit using its :commit_sha. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see 'Rate limits for the APIhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/rate-limits-for-the-rest-api about-secondary-rate-limits' and 'Best practicowner (string)
repo (string)
commit_sha (string)
data: {
. body (string)
. path (string)
. position (integer)
. line (integer)
} (object) required
get_repos_by_owner_by_repo_commits_by_commit_sha_pullsLists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.owner (string)
repo (string)
commit_sha (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_commits_by_refReturns 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 and the default JSON media type is requested, 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. This endpoint supports the following custom media types. For more informatowner (string)
repo (string)
ref (string)
page (integer)
per_page (integer)
get_repos_by_owner_by_repo_commits_by_ref_check_runsLists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. !NOTE The endpoints to manage checks only look 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. If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, useowner (string)
repo (string)
ref (string)
check_name (string)
status (string)
filter (string)
per_page (integer)
page (integer)
app_id (integer)
get_repos_by_owner_by_repo_commits_by_ref_check_suitesLists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. !NOTE The endpoints to manage checks only look 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. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint on a private repository.owner (string)
repo (string)
ref (string)
app_id (integer)
check_name (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_commits_by_ref_statusUsers 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 successowner (string)
repo (string)
ref (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_commits_by_ref_statusesUsers 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.owner (string)
repo (string)
ref (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_compare_by_baseheadCompares two commits against one another. You can compare refs branches or tags and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see 'Understanding connections between repositorieshttps://docs.github.com/enterprise-server@3.18/repositories/viewing-activity-and-data-for-your-repository/understanding-connectiowner (string)
repo (string)
basehead (string)
page (integer)
per_page (integer)
get_repos_by_owner_by_repo_contents_by_pathGets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw file contents forowner (string)
repo (string)
path (string)
ref (string)
put_repos_by_owner_by_repo_contents_by_pathCreates a new file or replaces an existing file in a repository. !NOTE If you use this endpoint and the 'Delete a filehttps://docs.github.com/enterprise-server@3.18/rest/repos/contents/ delete-a-file' endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in towner (string)
repo (string)
path (string)
data: {
. message (string)
. content (string)
. sha (string)
. branch (string)
. committer (object)
. author (object)
} (object) required
delete_repos_by_owner_by_repo_contents_by_pathDeletes 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 uowner (string)
repo (string)
path (string)
data: {
. message (string)
. sha (string)
. branch (string)
. committer (object)
. author (object)
} (object) required
get_repos_by_owner_by_repo_contributorsLists 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 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 reposowner (string)
repo (string)
anon (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_dependabot_alertsOAuth app tokens and personal access tokens classic need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.owner (string)
repo (string)
state (string)
severity (string)
ecosystem (string)
package (string)
manifest (string)
epss_percentage (string)
has (undefined)
scope (string)
sort (string)
direction (string)
page (integer)
per_page (integer)
before (string)
after (string)
first (integer)
last (integer)
get_repos_by_owner_by_repo_dependabot_alerts_by_alert_numberOAuth app tokens and personal access tokens classic need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.owner (string)
repo (string)
alert_number (undefined)
patch_repos_by_owner_by_repo_dependabot_alerts_by_alert_numberThe authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see 'Granting access to security alertshttps://docs.github.com/enterprise-server@3.18/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository granting-access-to-security-alerts.' OAuth app tokens and personal access tokens classic need the security_events scope to use thisowner (string)
repo (string)
alert_number (undefined)
data: {
. state (string)
. dismissed_reason (string)
. dismissed_comment (string)
} (object) required
get_repos_by_owner_by_repo_dependabot_secretsLists all secrets available in a repository without revealing their encrypted values. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_dependabot_secrets_public_keyGets 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. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint if the repository is private.owner (string)
repo (string)
get_repos_by_owner_by_repo_dependabot_secrets_by_secret_nameGets a single repository secret without revealing its encrypted value. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
secret_name (string)
put_repos_by_owner_by_repo_dependabot_secrets_by_secret_nameCreates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodiumhttps://libsodium.gitbook.io/doc/bindings_for_other_languages. For more information, see 'Encrypting secrets for the REST APIhttps://docs.github.com/enterprise-server@3.18/rest/guides/encrypting-secrets-for-the-rest-api.' OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
secret_name (string)
data: {
. encrypted_value (string)
. key_id (string)
} (object) required
delete_repos_by_owner_by_repo_dependabot_secrets_by_secret_nameDeletes a secret in a repository using the secret name. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
secret_name (string)
get_repos_by_owner_by_repo_dependency_graph_compare_by_baseheadGets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.owner (string)
repo (string)
basehead (string)
name (string)
get_repos_by_owner_by_repo_dependency_graph_sbomExports the software bill of materials SBOM for a repository in SPDX JSON format.owner (string)
repo (string)
post_repos_by_owner_by_repo_dependency_graph_snapshotsCreate a new snapshot of a repository's dependencies. The authenticated user must have access to the repository. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
data: {
. version (integer)
. job (object)
. sha (string)
. ref (string)
. detector (object)
. metadata
. manifests (object)
. scanned (string)
} (object) required
get_repos_by_owner_by_repo_deploymentsSimple filtering of deployments is available via query parameters:owner (string)
repo (string)
sha (string)
ref (string)
task (string)
environment (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_deploymentsDeployments 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 reqowner (string)
repo (string)
data: {
. ref (string)
. task (string)
. auto_merge (boolean)
. required_contexts (array)
. payload
. environment (string)
. description (string)
. transient_environment (boolean)
. production_environment (boolean)
} (object) required
get_repos_by_owner_by_repo_deployments_by_deployment_idGet a deploymentowner (string)
repo (string)
deployment_id (integer)
delete_repos_by_owner_by_repo_deployments_by_deployment_idIf the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active 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 deploymenowner (string)
repo (string)
deployment_id (integer)
get_repos_by_owner_by_repo_deployments_by_deployment_id_statusesUsers with pull access can view deployment statuses for a deployment:owner (string)
repo (string)
deployment_id (integer)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_deployments_by_deployment_id_statusesUsers with push access can create deployment statuses for a given deployment. OAuth app tokens and personal access tokens classic need the repo_deployment scope to use this endpoint.owner (string)
repo (string)
deployment_id (integer)
data: {
. state (string)
. target_url (string)
. log_url (string)
. description (string)
. environment (string)
. environment_url (string)
. auto_inactive (boolean)
} (object) required
get_repos_by_owner_by_repo_deployments_by_deployment_id_statuses_by_status_idUsers with pull access can view a deployment status for a deployment:owner (string)
repo (string)
deployment_id (integer)
status_id (integer)
get_repos_by_owner_by_repo_dismissal_requests_secret_scanningLists requests to dismiss secret scanning alerts in a repository. Delegated alert dismissal must be enabled on the repository and the user must be an org admin, security manager, or have the 'Review and manage secret scanning alert dismissal requests' permission to access this endpoint.owner (string)
repo (string)
reviewer (string)
requester (string)
time_period (string)
request_status (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_dismissal_requests_secret_scanning_by_alert_numberGets a specific request to dismiss a secret scanning alert in a repository. Delegated alert dismissal must be enabled on the repository and the user must be an org admin, security manager, or have the 'Review and manage secret scanning alert dismissal requests' permission to access this endpoint. Personal access tokens classic need the security_events scope to use this endpoint.owner (string)
repo (string)
alert_number (integer)
patch_repos_by_owner_by_repo_dismissal_requests_secret_scanning_by_alert_numberApprove or deny a request to dismiss a secret scanning alert in a repository. Delegated alert dismissal must be enabled on the repository and the user must be an org admin, security manager, or have the 'Review and manage secret scanning alert dismissal requests' permission to access this endpoint. Personal access tokens classic need the security_events scope to use this endpoint.owner (string)
repo (string)
alert_number (integer)
data: {
. status (string)
. message (string)
} (object) required
post_repos_by_owner_by_repo_dispatchesYou 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 'RepositoryDispatchEventhttps://docs.github.com/enterprise-server@3.18/webhooks/event-payloads/ repository_dispatch.' Towner (string)
repo (string)
data: {
. event_type (string)
. client_payload (object)
} (object) required
get_repos_by_owner_by_repo_environmentsLists the environments for a repository. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_environments_by_environment_name!NOTE To get information about name patterns that branches must match in order to deploy to this environment, see 'Get a deployment branch policy/rest/deployments/branch-policies get-a-deployment-branch-policy.' Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
environment_name (string)
put_repos_by_owner_by_repo_environments_by_environment_nameCreate or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see 'Environments/actions/reference/environments environment-protection-rules.' !NOTE To create or update name patterns that branches must match in order to deploy to this environment, see 'Deployment branch policies/rest/deployments/branch-policies.' !NOTE To create or update secrets for an environment, see 'GitHub Actions secrets/rest/actions/secretsowner (string)
repo (string)
environment_name (string)
data: {
. wait_timer (integer)
. prevent_self_review (boolean)
. reviewers (array)
. deployment_branch_policy (object)
} (object) required
delete_repos_by_owner_by_repo_environments_by_environment_nameOAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
get_repos_by_owner_by_repo_environments_by_environment_name_deployment_branch_policiesLists the deployment branch policies for an environment. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
environment_name (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_environments_by_environment_name_deployment_branch_policiesCreates a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
data: {
. name (string)
. type (string)
} (object) required
get_repos_by_owner_by_repo_environments_by_environment_name_deployment_branch_policies_by_branch_policy_idGets a deployment branch or tag policy for an environment. Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint with a private repository.owner (string)
repo (string)
environment_name (string)
branch_policy_id (integer)
put_repos_by_owner_by_repo_environments_by_environment_name_deployment_branch_policies_by_branch_policy_idUpdates a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
branch_policy_id (integer)
data: {
. name (string)
} (object) required
delete_repos_by_owner_by_repo_environments_by_environment_name_deployment_branch_policies_by_branch_policy_idDeletes a deployment branch or tag policy for an environment. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
branch_policy_id (integer)
get_repos_by_owner_by_repo_environments_by_environment_name_deployment_protection_rulesGets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see 'Using environments for deploymenthttps://docs.github.com/enterprise-server@3.18/actions/deployment/targeting-different-environments/using-environments-for-deployment.' For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/app_slug endpointenvironment_name (string)
repo (string)
owner (string)
post_repos_by_owner_by_repo_environments_by_environment_name_deployment_protection_rulesEnable a custom deployment protection rule for an environment. The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/app_slug endpointhttps://docs.github.com/enterprise-server@3.18/rest/apps/apps get-an-app, as well as the guide to creating custom deployment protection ruleshttps://docs.github.com/enterprise-server@3.18/actions/environment_name (string)
repo (string)
owner (string)
data: {
. integration_id (integer)
} (object) required
get_repos_by_owner_by_repo_environments_by_environment_name_deployment_protection_rules_appsGets all custom deployment protection rule integrations that are available for an environment. The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about environments, see 'Using environments for deploymenthttps://docs.github.com/enterprise-server@3.18/actions/deployment/targeting-different-environments/using-environments-for-deployment.' For more information about the app that is providing this custom deployment rule, see 'Genvironment_name (string)
repo (string)
owner (string)
page (integer)
per_page (integer)
get_repos_by_owner_by_repo_environments_by_environment_name_deployment_protection_rules_by_protection_rule_idGets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see 'Using environments for deploymenthttps://docs.github.com/enterprise-server@3.18/actions/deployment/targeting-different-environments/using-environments-for-deployment.' For more information about the app that is providing this custom deployment rule, see GET /apps/app_slughttps://docs.github.com/enterprise-server@3.18owner (string)
repo (string)
environment_name (string)
protection_rule_id (integer)
delete_repos_by_owner_by_repo_environments_by_environment_name_deployment_protection_rules_by_protection_rule_idDisables a custom deployment protection rule for an environment. The authenticated user must have admin or owner permissions to the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.environment_name (string)
repo (string)
owner (string)
protection_rule_id (integer)
get_repos_by_owner_by_repo_environments_by_environment_name_secretsLists all secrets available in an environment without revealing their encrypted values. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_environments_by_environment_name_secrets_public_keyGet 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, OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
get_repos_by_owner_by_repo_environments_by_environment_name_secrets_by_secret_nameGets a single environment secret without revealing its encrypted value. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
secret_name (string)
put_repos_by_owner_by_repo_environments_by_environment_name_secrets_by_secret_nameCreates or updates an environment secret with an encrypted value. Encrypt your secret using LibSodiumhttps://libsodium.gitbook.io/doc/bindings_for_other_languages. For more information, see 'Encrypting secrets for the REST APIhttps://docs.github.com/enterprise-server@3.18/rest/guides/encrypting-secrets-for-the-rest-api.' Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens classic need the repo scope to usowner (string)
repo (string)
environment_name (string)
secret_name (string)
data: {
. encrypted_value (string)
. key_id (string)
} (object) required
delete_repos_by_owner_by_repo_environments_by_environment_name_secrets_by_secret_nameDeletes a secret in an environment using the secret name. Authenticated users must have collaborator access to a repository to create, update, or read secrets. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
secret_name (string)
get_repos_by_owner_by_repo_environments_by_environment_name_variablesLists all environment variables. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_environments_by_environment_name_variablesCreate an environment variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
data: {
. name (string)
. value (string)
} (object) required
get_repos_by_owner_by_repo_environments_by_environment_name_variables_by_nameGets a specific variable in an environment. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
environment_name (string)
name (string)
patch_repos_by_owner_by_repo_environments_by_environment_name_variables_by_nameUpdates an environment variable that you can reference in a GitHub Actions workflow. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
name (string)
environment_name (string)
data: {
. name (string)
. value (string)
} (object) required
delete_repos_by_owner_by_repo_environments_by_environment_name_variables_by_nameDeletes an environment variable using the variable name. Authenticated users must have collaborator access to a repository to create, update, or read variables. OAuth tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
name (string)
environment_name (string)
get_repos_by_owner_by_repo_events!NOTE This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_forksList forksowner (string)
repo (string)
sort (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_forksCreate 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 Supporthttps://support.github.com/contact?tags=dotcom-rest-api. !NOTE Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account wiowner (string)
repo (string)
data: {
. organization (string)
. name (string)
. default_branch_only (boolean)
} (object) required
post_repos_by_owner_by_repo_git_blobsCreate a blobowner (string)
repo (string)
data: {
. content (string)
. encoding (string)
} (object) required
get_repos_by_owner_by_repo_git_blobs_by_file_shaThe content in the response will always be Base64 encoded. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw blob data. - application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specifiedowner (string)
repo (string)
file_sha (string)
post_repos_by_owner_by_repo_git_commitsCreates a new Git commit objecthttps://git-scm.com/book/en/v2/Git-Internals-Git-Objects. 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: | Name | Type | Description | | ---- | ---- | ----------- | | verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. | | reason | string | The reason for verifowner (string)
repo (string)
data: {
. message (string)
. tree (string)
. parents (array)
. author (object)
. committer (object)
. signature (string)
} (object) required
get_repos_by_owner_by_repo_git_commits_by_commit_shaGets a Git commit objecthttps://git-scm.com/book/en/v2/Git-Internals-Git-Objects. To get the contents of a commit, see 'Get a commit/rest/commits/commits get-a-commit.' 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: | Name | Type | Description | | ---- | ---- | ----------- | | verified | boolean | Indicates whether GitHub considers the siowner (string)
repo (string)
commit_sha (string)
get_repos_by_owner_by_repo_git_matching_refs_by_refReturns 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 nameowner (string)
repo (string)
ref (string)
get_repos_by_owner_by_repo_git_ref_by_refReturns 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 requesthttps://docs.github.com/enterprise-server@3.18/rest/pulls/pulls get-a-pull-request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see 'Checking mergeability of pull requestshttpsowner (string)
repo (string)
ref (string)
post_repos_by_owner_by_repo_git_refsCreates 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.owner (string)
repo (string)
data: {
. ref (string)
. sha (string)
} (object) required
patch_repos_by_owner_by_repo_git_refs_by_refUpdates the provided reference to point to a new SHA. For more information, see 'Git Referenceshttps://git-scm.com/book/en/v2/Git-Internals-Git-References' in the Git documentation.owner (string)
repo (string)
ref (string)
data: {
. sha (string)
. force (boolean)
} (object) required
delete_repos_by_owner_by_repo_git_refs_by_refDeletes the provided reference.owner (string)
repo (string)
ref (string)
post_repos_by_owner_by_repo_git_tagsNote 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 createhttps://docs.github.com/enterprise-server@3.18/rest/git/refs create-a-reference the refs/tags/tag reference. If you want to create a lightweight tag, you only have to createhttps://docs.github.com/enterprise-server@3.18/rest/git/refs create-a-reference the tag reference - this call would be unnecessowner (string)
repo (string)
data: {
. tag (string)
. message (string)
. object (string)
. type (string)
. tagger (object)
} (object) required
get_repos_by_owner_by_repo_git_tags_by_tag_shaSignature 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: | Name | Type | Description | | ---- | ---- | ----------- | | verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. | | reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. | | signatureowner (string)
repo (string)
tag_sha (string)
post_repos_by_owner_by_repo_git_treesThe 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 commithttps://docs.github.com/enterprise-server@3.18/rest/git/commits creatowner (string)
repo (string)
data: {
. tree (array)
. base_tree (string)
} (object) required
get_repos_by_owner_by_repo_git_trees_by_tree_shaReturns a single tree using the SHA1 value or ref name 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. !NOTE The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.owner (string)
repo (string)
tree_sha (string)
recursive (string)
get_repos_by_owner_by_repo_hooksLists webhooks for a repository. last response may return null if there have not been any deliveries within 30 days.owner (string)
repo (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_hooksRepositories 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.owner (string)
repo (string)
data: {
. name (string)
. config (object)
. events (array)
. active (boolean)
} (object) required
get_repos_by_owner_by_repo_hooks_by_hook_idReturns a webhook configured in a repository. To get only the webhook config properties, see 'Get a webhook configuration for a repository/rest/webhooks/repo-config get-a-webhook-configuration-for-a-repository.'owner (string)
repo (string)
hook_id (integer)
patch_repos_by_owner_by_repo_hooks_by_hook_idUpdates 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/rest/webhooks/repo-config update-a-webhook-configuration-for-a-repository.'owner (string)
repo (string)
hook_id (integer)
data: {
. config (object)
. events (array)
. add_events (array)
. remove_events (array)
. active (boolean)
} (object) required
delete_repos_by_owner_by_repo_hooks_by_hook_idDelete a webhook for an organization. The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.owner (string)
repo (string)
hook_id (integer)
get_repos_by_owner_by_repo_hooks_by_hook_id_configReturns the webhook configuration for a repository. To get more information about the webhook, including the active state and events, use 'Get a repository webhook/rest/webhooks/repos get-a-repository-webhook.' OAuth app tokens and personal access tokens classic need the read:repo_hook or repo scope to use this endpoint.owner (string)
repo (string)
hook_id (integer)
patch_repos_by_owner_by_repo_hooks_by_hook_id_configUpdates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use 'Update a repository webhook/rest/webhooks/repos update-a-repository-webhook.' OAuth app tokens and personal access tokens classic need the write:repo_hook or repo scope to use this endpoint.owner (string)
repo (string)
hook_id (integer)
data: {
. url (string)
. content_type (string)
. secret (string)
. insecure_ssl
} (object) required
get_repos_by_owner_by_repo_hooks_by_hook_id_deliveriesReturns a list of webhook deliveries for a webhook configured in a repository.owner (string)
repo (string)
hook_id (integer)
per_page (integer)
cursor (string)
get_repos_by_owner_by_repo_hooks_by_hook_id_deliveries_by_delivery_idReturns a delivery for a webhook configured in a repository.owner (string)
repo (string)
hook_id (integer)
delivery_id (integer)
post_repos_by_owner_by_repo_hooks_by_hook_id_deliveries_by_delivery_id_attemptsRedeliver a webhook delivery for a webhook configured in a repository.owner (string)
repo (string)
hook_id (integer)
delivery_id (integer)
post_repos_by_owner_by_repo_hooks_by_hook_id_pingsThis will trigger a ping eventhttps://docs.github.com/enterprise-server@3.18/webhooks/ ping-event to be sent to the hook.owner (string)
repo (string)
hook_id (integer)
post_repos_by_owner_by_repo_hooks_by_hook_id_testsThis 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/testowner (string)
repo (string)
hook_id (integer)
get_repos_by_owner_by_repo_installationEnables 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 JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.owner (string)
repo (string)
get_repos_by_owner_by_repo_invitationsWhen authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.owner (string)
repo (string)
per_page (integer)
page (integer)
patch_repos_by_owner_by_repo_invitations_by_invitation_idUpdate a repository invitationowner (string)
repo (string)
invitation_id (integer)
data: {
. permissions (string)
} (object) required
delete_repos_by_owner_by_repo_invitations_by_invitation_idDelete a repository invitationowner (string)
repo (string)
invitation_id (integer)
get_repos_by_owner_by_repo_issuesList issues in a repository. Only open issues will be listed. !NOTE GitHub's REST API 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 requestshttps://docs.github.com/enteowner (string)
repo (string)
milestone (string)
state (string)
assignee (string)
type (string)
creator (string)
mentioned (string)
labels (string)
sort (string)
direction (string)
since (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_issuesAny user with pull access to a repository can create an issue. If issues are disabled in the repositoryhttps://docs.github.com/enterprise-server@3.18/articles/disabling-issues/, the API returns a 410 Gone status. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see 'Rate limiowner (string)
repo (string)
data: {
. title
. body (string)
. assignee (string)
. milestone
. labels (array)
. assignees (array)
. type (string)
} (object) required
get_repos_by_owner_by_repo_issues_commentsYou can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. By default, issue comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown body. Reowner (string)
repo (string)
sort (string)
direction (string)
since (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_issues_comments_by_comment_idYou can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specifowner (string)
repo (string)
comment_id (integer)
patch_repos_by_owner_by_repo_issues_comments_by_comment_idYou can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any speowner (string)
repo (string)
comment_id (integer)
data: {
. body (string)
} (object) required
delete_repos_by_owner_by_repo_issues_comments_by_comment_idYou can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.owner (string)
repo (string)
comment_id (integer)
get_repos_by_owner_by_repo_issues_comments_by_comment_id_reactionsList the reactions to an issue commenthttps://docs.github.com/enterprise-server@3.18/rest/issues/comments get-an-issue-comment.owner (string)
repo (string)
comment_id (integer)
content (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_issues_comments_by_comment_id_reactionsCreate a reaction to an issue commenthttps://docs.github.com/enterprise-server@3.18/rest/issues/comments get-an-issue-comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.owner (string)
repo (string)
comment_id (integer)
data: {
. content (string)
} (object) required
delete_repos_by_owner_by_repo_issues_comments_by_comment_id_reactions_by_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 commenthttps://docs.github.com/enterprise-server@3.18/rest/issues/comments get-an-issue-comment.owner (string)
repo (string)
comment_id (integer)
reaction_id (integer)
get_repos_by_owner_by_repo_issues_eventsLists events for a repository.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_issues_events_by_event_idGets a single event by the event id.owner (string)
repo (string)
event_id (integer)
get_repos_by_owner_by_repo_issues_by_issue_numberThe API returns a 301 Moved Permanently statushttps://docs.github.com/enterprise-server@3.18/rest/guides/best-practices-for-using-the-rest-api follow-redirects if the issue was transferredhttps://docs.github.com/enterprise-server@3.18/articles/transferring-an-issue-to-another-repository/ 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 repositowner (string)
repo (string)
issue_number (integer)
patch_repos_by_owner_by_repo_issues_by_issue_numberIssue owners and users with push access or Triage role can edit an issue. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text oowner (string)
repo (string)
issue_number (integer)
data: {
. title
. body (string)
. assignee (string)
. state (string)
. state_reason (string)
. milestone
. labels (array)
. assignees (array)
. type (string)
} (object) required
post_repos_by_owner_by_repo_issues_by_issue_number_assigneesAdds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.owner (string)
repo (string)
issue_number (integer)
data: {
. assignees (array)
} (object) required
delete_repos_by_owner_by_repo_issues_by_issue_number_assigneesRemoves one or more assignees from an issue.owner (string)
repo (string)
issue_number (integer)
data: {
. assignees (array)
} (object) required
get_repos_by_owner_by_repo_issues_by_issue_number_assignees_by_assigneeChecks if a user has permission to be assigned to a specific issue. If the assignee can be assigned to this issue, a 204 status code with no content is returned. Otherwise a 404 status code is returned.owner (string)
repo (string)
issue_number (integer)
assignee (string)
get_repos_by_owner_by_repo_issues_by_issue_number_commentsYou can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. Issue comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. Thiowner (string)
repo (string)
issue_number (integer)
since (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_issues_by_issue_number_commentsYou can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see 'Rate limits for the APIhttps://docs.github.com/enterprise-server@3.18/rest/usiowner (string)
repo (string)
issue_number (integer)
data: {
. body (string)
} (object) required
get_repos_by_owner_by_repo_issues_by_issue_number_eventsLists all events for an issue.owner (string)
repo (string)
issue_number (integer)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_issues_by_issue_number_labelsLists all labels for an issue.owner (string)
repo (string)
issue_number (integer)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_issues_by_issue_number_labelsAdds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.owner (string)
repo (string)
issue_number (integer)
data (undefined) required
put_repos_by_owner_by_repo_issues_by_issue_number_labelsRemoves any previous labels and sets the new labels for an issue.owner (string)
repo (string)
issue_number (integer)
data (undefined) required
delete_repos_by_owner_by_repo_issues_by_issue_number_labelsRemoves all labels from an issue.owner (string)
repo (string)
issue_number (integer)
delete_repos_by_owner_by_repo_issues_by_issue_number_labels_by_nameRemoves 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.owner (string)
repo (string)
issue_number (integer)
name (string)
put_repos_by_owner_by_repo_issues_by_issue_number_lockUsers 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 methodhttps://docs.github.com/enterprise-server@3.18/rest/guides/getting-started-with-the-rest-api http-method.'owner (string)
repo (string)
issue_number (integer)
data: {
. lock_reason (string)
} (object) required
delete_repos_by_owner_by_repo_issues_by_issue_number_lockUsers with push access can unlock an issue's conversation.owner (string)
repo (string)
issue_number (integer)
get_repos_by_owner_by_repo_issues_by_issue_number_reactionsList the reactions to an issuehttps://docs.github.com/enterprise-server@3.18/rest/issues/issues get-an-issue.owner (string)
repo (string)
issue_number (integer)
content (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_issues_by_issue_number_reactionsCreate a reaction to an issuehttps://docs.github.com/enterprise-server@3.18/rest/issues/issues get-an-issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.owner (string)
repo (string)
issue_number (integer)
data: {
. content (string)
} (object) required
delete_repos_by_owner_by_repo_issues_by_issue_number_reactions_by_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 issuehttps://docs.github.com/enterprise-server@3.18/rest/issues/issues get-an-issue.owner (string)
repo (string)
issue_number (integer)
reaction_id (integer)
get_repos_by_owner_by_repo_issues_by_issue_number_timelineList all timeline events for an issue.owner (string)
repo (string)
issue_number (integer)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_keysList deploy keysowner (string)
repo (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_keysYou can create a read-only deploy key.owner (string)
repo (string)
data: {
. title (string)
. key (string)
. read_only (boolean)
} (object) required
get_repos_by_owner_by_repo_keys_by_key_idGet a deploy keyowner (string)
repo (string)
key_id (integer)
delete_repos_by_owner_by_repo_keys_by_key_idDeploy keys are immutable. If you need to update a key, remove the key and create a new one instead.owner (string)
repo (string)
key_id (integer)
get_repos_by_owner_by_repo_labelsLists all labels for a repository.owner (string)
repo (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_labelsCreates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color codehttp://www.color-hex.com/.owner (string)
repo (string)
data: {
. name (string)
. color (string)
. description (string)
} (object) required
get_repos_by_owner_by_repo_labels_by_nameGets a label using the given name.owner (string)
repo (string)
name (string)
patch_repos_by_owner_by_repo_labels_by_nameUpdates a label using the given label name.owner (string)
repo (string)
name (string)
data: {
. new_name (string)
. color (string)
. description (string)
} (object) required
delete_repos_by_owner_by_repo_labels_by_nameDeletes a label using the given label name.owner (string)
repo (string)
name (string)
get_repos_by_owner_by_repo_languagesLists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.owner (string)
repo (string)
put_repos_by_owner_by_repo_lfsEnables Git LFS for a repository. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.owner (string)
repo (string)
delete_repos_by_owner_by_repo_lfsDisables Git LFS for a repository. OAuth app tokens and personal access tokens classic need the admin:enterprise scope to use this endpoint.owner (string)
repo (string)
get_repos_by_owner_by_repo_licenseThis method returns the contents of the repository's license file, if one is detected. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw contents of the license. - application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using Gitowner (string)
repo (string)
ref (undefined)
post_repos_by_owner_by_repo_merge_upstreamSync a branch of a forked repository to keep it up-to-date with the upstream repository.owner (string)
repo (string)
data: {
. branch (string)
} (object) required
post_repos_by_owner_by_repo_mergesMerge a branchowner (string)
repo (string)
data: {
. base (string)
. head (string)
. commit_message (string)
} (object) required
get_repos_by_owner_by_repo_milestonesLists milestones for a repository.owner (string)
repo (string)
state (string)
sort (string)
direction (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_milestonesCreates a milestone.owner (string)
repo (string)
data: {
. title (string)
. state (string)
. description (string)
. due_on (string)
} (object) required
get_repos_by_owner_by_repo_milestones_by_milestone_numberGets a milestone using the given milestone number.owner (string)
repo (string)
milestone_number (integer)
patch_repos_by_owner_by_repo_milestones_by_milestone_numberUpdate a milestoneowner (string)
repo (string)
milestone_number (integer)
data: {
. title (string)
. state (string)
. description (string)
. due_on (string)
} (object) required
delete_repos_by_owner_by_repo_milestones_by_milestone_numberDeletes a milestone using the given milestone number.owner (string)
repo (string)
milestone_number (integer)
get_repos_by_owner_by_repo_milestones_by_milestone_number_labelsLists labels for issues in a milestone.owner (string)
repo (string)
milestone_number (integer)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_notificationsLists all notifications for the current user in the specified repository.owner (string)
repo (string)
all (boolean)
participating (boolean)
since (string)
before (string)
per_page (integer)
page (integer)
put_repos_by_owner_by_repo_notificationsMarks all notifications in a repository as 'read' for the current user. 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 userhttps://docs.github.com/enterprise-server@3.18/rest/activity/notifications list-repository-notificowner (string)
repo (string)
data: {
. last_read_at (string)
} (object) required
get_repos_by_owner_by_repo_pagesGets information about a GitHub Enterprise Server Pages site. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
post_repos_by_owner_by_repo_pagesConfigures a GitHub Enterprise Server Pages site. For more information, see 'About GitHub Pages/github/working-with-github-pages/about-github-pages.' The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
data: {
. build_type (string)
. source (object)
} (object) required
put_repos_by_owner_by_repo_pagesUpdates information for a GitHub Enterprise Server Pages site. For more information, see 'About GitHub Pages/github/working-with-github-pages/about-github-pages. The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
data: {
. cname (string)
. https_enforced (boolean)
. build_type (string)
. source
} (object) required
delete_repos_by_owner_by_repo_pagesDeletes a GitHub Enterprise Server Pages site. For more information, see 'About GitHub Pages/github/working-with-github-pages/about-github-pages. The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
get_repos_by_owner_by_repo_pages_buildsLists builts of a GitHub Enterprise Server Pages site. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_pages_buildsYou 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 thowner (string)
repo (string)
get_repos_by_owner_by_repo_pages_builds_latestGets information about the single most recent build of a GitHub Enterprise Server Pages site. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
get_repos_by_owner_by_repo_pages_builds_by_build_idGets information about a GitHub Enterprise Server Pages build. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
build_id (integer)
post_repos_by_owner_by_repo_pages_deploymentsCreate a GitHub Pages deployment for a repository. The authenticated user must have write permission to the repository.owner (string)
repo (string)
data: {
. artifact_url (string)
. environment (string)
. pages_build_version (string)
. oidc_token (string)
} (object) required
get_repos_by_owner_by_repo_pages_deployments_by_pages_deployment_idGets the current status of a GitHub Pages deployment. The authenticated user must have read permission for the GitHub Pages site.owner (string)
repo (string)
pages_deployment_id (undefined)
post_repos_by_owner_by_repo_pages_deployments_by_pages_deployment_id_cancelCancels a GitHub Pages deployment. The authenticated user must have write permissions for the GitHub Pages site.owner (string)
repo (string)
pages_deployment_id (undefined)
get_repos_by_owner_by_repo_pre_receive_hooksList 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.owner (string)
repo (string)
per_page (integer)
page (integer)
direction (string)
sort (string)
get_repos_by_owner_by_repo_pre_receive_hooks_by_pre_receive_hook_idGet a pre-receive hook for a repositoryowner (string)
repo (string)
pre_receive_hook_id (integer)
patch_repos_by_owner_by_repo_pre_receive_hooks_by_pre_receive_hook_idFor pre-receive hooks which are allowed to be configured at the repo level, you can set enforcementowner (string)
repo (string)
pre_receive_hook_id (integer)
data: {
. enforcement (string)
} (object) required
delete_repos_by_owner_by_repo_pre_receive_hooks_by_pre_receive_hook_idDeletes any overridden enforcement on this repository for the specified hook. Responds with effective values inherited from owner and/or global level.owner (string)
repo (string)
pre_receive_hook_id (integer)
get_repos_by_owner_by_repo_properties_valuesGets all custom property values that are set for a repository. Users with read access to the repository can use this endpoint.owner (string)
repo (string)
patch_repos_by_owner_by_repo_properties_valuesCreate new or update existing custom property values for a repository. Using a value of null for a custom property will remove or 'unset' the property value from the repository. Repository admins and other users with the repository-level 'edit custom property values' fine-grained permission can use this endpoint.owner (string)
repo (string)
data: {
. properties (array)
} (object) required
get_repos_by_owner_by_repo_pullsLists pull requests in a specified repository. 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. This endpoint supports the fowner (string)
repo (string)
state (string)
head (string)
base (string)
sort (string)
direction (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_pullsDraft 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. To open or update a pull request in a public repository, you must have writeowner (string)
repo (string)
data: {
. title (string)
. head (string)
. head_repo (string)
. base (string)
. body (string)
. maintainer_can_modify (boolean)
. draft (boolean)
. issue (integer)
} (object) required
get_repos_by_owner_by_repo_pulls_commentsLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific mediaowner (string)
repo (string)
sort (string)
direction (string)
since (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_pulls_comments_by_comment_idProvides details for a specified review comment. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a texowner (string)
repo (string)
comment_id (integer)
patch_repos_by_owner_by_repo_pulls_comments_by_comment_idEdits the content of a specified review comment. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a texowner (string)
repo (string)
comment_id (integer)
data: {
. body (string)
} (object) required
delete_repos_by_owner_by_repo_pulls_comments_by_comment_idDeletes a review comment.owner (string)
repo (string)
comment_id (integer)
get_repos_by_owner_by_repo_pulls_comments_by_comment_id_reactionsList the reactions to a pull request review commenthttps://docs.github.com/enterprise-server@3.18/rest/pulls/comments get-a-review-comment-for-a-pull-request.owner (string)
repo (string)
comment_id (integer)
content (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_pulls_comments_by_comment_id_reactionsCreate a reaction to a pull request review commenthttps://docs.github.com/enterprise-server@3.18/rest/pulls/comments get-a-review-comment-for-a-pull-request. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.owner (string)
repo (string)
comment_id (integer)
data: {
. content (string)
} (object) required
delete_repos_by_owner_by_repo_pulls_comments_by_comment_id_reactions_by_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 commenthttps://docs.github.com/enterprise-server@3.18/rest/pulls/comments get-a-review-comment-for-a-pull-request.owner (string)
repo (string)
comment_id (integer)
reaction_id (integer)
get_repos_by_owner_by_repo_pulls_by_pull_numberDraft 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. Lists details of a pull request by providing its number. When you get, creaowner (string)
repo (string)
pull_number (integer)
patch_repos_by_owner_by_repo_pulls_by_pull_numberDraft 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-with-github/githubs-products in the GitHub Help documentation. To open or update a pull request in a public repository, you must have writeowner (string)
repo (string)
pull_number (integer)
data: {
. title (string)
. body (string)
. state (string)
. base (string)
. maintainer_can_modify (boolean)
} (object) required
get_repos_by_owner_by_repo_pulls_by_pull_number_commentsLists all review comments for a specified pull request. By default, review comments are in ascending order by ID. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media typeowner (string)
repo (string)
pull_number (integer)
sort (string)
direction (string)
since (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_pulls_by_pull_number_commentsCreates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see 'Create an issue commenthttps://docs.github.com/enterprise-server@3.18/rest/issues/comments create-an-issue-comment.' If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request. The position parameter is closing down. If you use position, the line, side, start_liowner (string)
repo (string)
pull_number (integer)
data: {
. body (string)
. commit_id (string)
. path (string)
. position (integer)
. side (string)
. line (integer)
. start_line (integer)
. start_side (string)
. in_reply_to (integer)
. subject_type (string)
} (object) required
post_repos_by_owner_by_repo_pulls_by_pull_number_comments_by_comment_id_repliesCreates 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 notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limitowner (string)
repo (string)
pull_number (integer)
comment_id (integer)
data: {
. body (string)
} (object) required
get_repos_by_owner_by_repo_pulls_by_pull_number_commitsLists 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 commitshttps://docs.github.com/enterprise-server@3.18/rest/commits/commits list-commits endpoint. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returnsowner (string)
repo (string)
pull_number (integer)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_pulls_by_pull_number_filesLists the files in a specified pull request. !NOTE Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do noowner (string)
repo (string)
pull_number (integer)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_pulls_by_pull_number_mergeChecks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.owner (string)
repo (string)
pull_number (integer)
put_repos_by_owner_by_repo_pulls_by_pull_number_mergeMerges a pull request into the base branch. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see 'Rate limits for the APIhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/rate-limits-for-the-rest-api about-secondary-rate-limits' and 'Best practices for usiowner (string)
repo (string)
pull_number (integer)
data: {
. commit_title (string)
. commit_message (string)
. sha (string)
. merge_method (string)
} (object) required
get_repos_by_owner_by_repo_pulls_by_pull_number_requested_reviewersGets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull requesthttps://docs.github.com/enterprise-server@3.18/rest/pulls/reviews list-reviews-for-a-pull-request operation.owner (string)
repo (string)
pull_number (integer)
post_repos_by_owner_by_repo_pulls_by_pull_number_requested_reviewersRequests reviews for a pull request from a given set of users and/or teams. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see 'Rate limits for the APIhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/rate-limits-for-the-rest-api about-secondary-rate-limowner (string)
repo (string)
pull_number (integer)
data: {
. reviewers (array)
. team_reviewers (array)
} (object) required
delete_repos_by_owner_by_repo_pulls_by_pull_number_requested_reviewersRemoves review requests from a pull request for a given set of users and/or teams.owner (string)
repo (string)
pull_number (integer)
data: {
. reviewers (array)
. team_reviewers (array)
} (object) required
get_repos_by_owner_by_repo_pulls_by_pull_number_reviewsLists all reviews for a specified pull request. The list of reviews returns in chronological order. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - applicatioowner (string)
repo (string)
pull_number (integer)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_pulls_by_pull_number_reviewsCreates a review on a specified pull request. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see 'Rate limits for the APIhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/rate-limits-for-the-rest-api about-secondary-rate-limits' and 'Best practices forowner (string)
repo (string)
pull_number (integer)
data: {
. commit_id (string)
. body (string)
. event (string)
. comments (array)
} (object) required
get_repos_by_owner_by_repo_pulls_by_pull_number_reviews_by_review_idRetrieves a pull request review by its ID. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text onlyowner (string)
repo (string)
pull_number (integer)
review_id (integer)
put_repos_by_owner_by_repo_pulls_by_pull_number_reviews_by_review_idUpdates the contents of a specified review summary comment. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Reowner (string)
repo (string)
pull_number (integer)
review_id (integer)
data: {
. body (string)
} (object) required
delete_repos_by_owner_by_repo_pulls_by_pull_number_reviews_by_review_idDeletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnowner (string)
repo (string)
pull_number (integer)
review_id (integer)
get_repos_by_owner_by_repo_pulls_by_pull_number_reviews_by_review_id_commentsLists comments for a specific pull request review. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a towner (string)
repo (string)
pull_number (integer)
review_id (integer)
per_page (integer)
page (integer)
put_repos_by_owner_by_repo_pulls_by_pull_number_reviews_by_review_id_dismissalsDismisses a specified review on a pull request. !NOTE To dismiss a pull request review on a protected branchhttps://docs.github.com/enterprise-server@3.18/rest/branches/branch-protection, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-witowner (string)
repo (string)
pull_number (integer)
review_id (integer)
data: {
. message (string)
. event (string)
} (object) required
post_repos_by_owner_by_repo_pulls_by_pull_number_reviews_by_review_id_eventsSubmits a pending review for a pull request. For more information about creating a pending review for a pull request, see 'Create a review for a pull requesthttps://docs.github.com/enterprise-server@3.18/rest/pulls/reviews create-a-review-for-a-pull-request.' This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.githubowner (string)
repo (string)
pull_number (integer)
review_id (integer)
data: {
. body (string)
. event (string)
} (object) required
put_repos_by_owner_by_repo_pulls_by_pull_number_update_branchUpdates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.owner (string)
repo (string)
pull_number (integer)
data: {
. expected_head_sha (string)
} (object) required
get_repos_by_owner_by_repo_readmeGets the preferred README for a repository. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type. - application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's oowner (string)
repo (string)
ref (string)
get_repos_by_owner_by_repo_readme_by_dirGets the README from a repository directory. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type. - application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub'sowner (string)
repo (string)
dir (string)
ref (string)
get_repos_by_owner_by_repo_releasesThis 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 APIhttps://docs.github.com/enterprise-server@3.18/rest/repos/repos list-repository-tags. Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.owner (string)
repo (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_releasesUsers with push access to the repository can create a release. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see 'Rate limits for the APIhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/rate-limits-for-the-rest-api about-secondary-rate-limits' and 'Beowner (string)
repo (string)
data: {
. tag_name (string)
. target_commitish (string)
. name (string)
. body (string)
. draft (boolean)
. prerelease (boolean)
. generate_release_notes (boolean)
. make_latest (string)
} (object) required
get_repos_by_owner_by_repo_releases_assets_by_asset_idTo download the asset's binary content: - If within a browser, fetch the location specified in the browser_download_url key provided in the response. - Alternatively, set the Accept header of the request to application/octet-streamhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types. 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 responowner (string)
repo (string)
asset_id (integer)
patch_repos_by_owner_by_repo_releases_assets_by_asset_idUsers with push access to the repository can edit a release asset.owner (string)
repo (string)
asset_id (integer)
data: {
. name (string)
. label (string)
. state (string)
} (object) required
delete_repos_by_owner_by_repo_releases_assets_by_asset_idDelete a release assetowner (string)
repo (string)
asset_id (integer)
post_repos_by_owner_by_repo_releases_generate_notesGenerate a name and body describing a releasehttps://docs.github.com/enterprise-server@3.18/rest/releases/releases get-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.owner (string)
repo (string)
data: {
. tag_name (string)
. target_commitish (string)
. previous_tag_name (string)
. configuration_file_path (string)
} (object) required
get_repos_by_owner_by_repo_releases_latestView 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.owner (string)
repo (string)
get_repos_by_owner_by_repo_releases_tags_by_tagGet a published release with the specified tag.owner (string)
repo (string)
tag (string)
get_repos_by_owner_by_repo_releases_by_release_idGets a public release with the specified release ID. !NOTE This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see 'Getting started with the REST APIhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api hypermedia.'owner (string)
repo (string)
release_id (integer)
patch_repos_by_owner_by_repo_releases_by_release_idUsers with push access to the repository can edit a release.owner (string)
repo (string)
release_id (integer)
data: {
. tag_name (string)
. target_commitish (string)
. name (string)
. body (string)
. draft (boolean)
. prerelease (boolean)
. make_latest (string)
} (object) required
delete_repos_by_owner_by_repo_releases_by_release_idUsers with push access to the repository can delete a release.owner (string)
repo (string)
release_id (integer)
get_repos_by_owner_by_repo_releases_by_release_id_assetsList release assetsowner (string)
repo (string)
release_id (integer)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_releases_by_release_id_assetsThis endpoint makes use of a Hypermedia relationhttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api hypermedia 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 endpointhttps://docs.github.com/enterprise-server@3.18/rest/releases/releases create-a-release to upload a release asset. You need to use an HTTP client whicowner (string)
repo (string)
release_id (integer)
name (string) required
label (string)
get_repos_by_owner_by_repo_releases_by_release_id_reactionsList the reactions to a releasehttps://docs.github.com/enterprise-server@3.18/rest/releases/releases get-a-release.owner (string)
repo (string)
release_id (integer)
content (string)
per_page (integer)
page (integer)
post_repos_by_owner_by_repo_releases_by_release_id_reactionsCreate a reaction to a releasehttps://docs.github.com/enterprise-server@3.18/rest/releases/releases get-a-release. A response with a Status: 200 OK means that you already added the reaction type to this release.owner (string)
repo (string)
release_id (integer)
data: {
. content (string)
} (object) required
delete_repos_by_owner_by_repo_releases_by_release_id_reactions_by_reaction_id!NOTE You can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id. Delete a reaction to a releasehttps://docs.github.com/enterprise-server@3.18/rest/releases/releases get-a-release.owner (string)
repo (string)
release_id (integer)
reaction_id (integer)
get_repos_by_owner_by_repo_replicas_cachesLists the status of each repository cache replica.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_rules_branches_by_branchReturns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level at which they are configured e.g. repository or organization. Rules in rulesets with 'evaluate' or 'disabled' enforcement statuses are not returned.owner (string)
repo (string)
branch (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_rulesetsGet all the rulesets for a repository.owner (string)
repo (string)
per_page (integer)
page (integer)
includes_parents (boolean)
targets (string)
post_repos_by_owner_by_repo_rulesetsCreate a ruleset for a repository.owner (string)
repo (string)
data: {
. name (string)
. target (string)
. enforcement (string)
. bypass_actors (array)
. conditions (object)
. rules (array)
} (object) required
get_repos_by_owner_by_repo_rulesets_rule_suitesLists suites of rule evaluations at the repository level. For more information, see 'Managing rulesets for a repositoryhttps://docs.github.com/enterprise-server@3.18/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository viewing-insights-for-rulesets.'owner (string)
repo (string)
ref (string)
time_period (string)
actor_name (string)
rule_suite_result (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_rulesets_rule_suites_by_rule_suite_idGets information about a suite of rule evaluations from within a repository. For more information, see 'Managing rulesets for a repositoryhttps://docs.github.com/enterprise-server@3.18/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository viewing-insights-for-rulesets.'owner (string)
repo (string)
rule_suite_id (integer)
get_repos_by_owner_by_repo_rulesets_by_ruleset_idGet a ruleset for a repository. Note: To prevent leaking sensitive information, the bypass_actors property is only returned if the user making the API request has write access to the ruleset.owner (string)
repo (string)
ruleset_id (integer)
includes_parents (boolean)
put_repos_by_owner_by_repo_rulesets_by_ruleset_idUpdate a ruleset for a repository.owner (string)
repo (string)
ruleset_id (integer)
data: {
. name (string)
. target (string)
. enforcement (string)
. bypass_actors (array)
. conditions (object)
. rules (array)
} (object) required
delete_repos_by_owner_by_repo_rulesets_by_ruleset_idDelete a ruleset for a repository.owner (string)
repo (string)
ruleset_id (integer)
get_repos_by_owner_by_repo_secret_scanning_alertsLists secret scanning alerts for an eligible repository, from newest to oldest. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.owner (string)
repo (string)
state (string)
secret_type (string)
resolution (string)
sort (string)
direction (string)
page (integer)
per_page (integer)
before (string)
after (string)
validity (string)
is_publicly_leaked (boolean)
is_multi_repo (boolean)
hide_secret (boolean)
get_repos_by_owner_by_repo_secret_scanning_alerts_by_alert_numberGets a single secret scanning alert detected in an eligible repository. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.owner (string)
repo (string)
alert_number (undefined)
hide_secret (boolean)
patch_repos_by_owner_by_repo_secret_scanning_alerts_by_alert_numberUpdates the status of a secret scanning alert in an eligible repository. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.owner (string)
repo (string)
alert_number (undefined)
data: {
. state (string)
. resolution (string)
. resolution_comment (string)
} (object) required
get_repos_by_owner_by_repo_secret_scanning_alerts_by_alert_number_locationsLists all locations for a given secret scanning alert for an eligible repository. The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens classic need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.owner (string)
repo (string)
alert_number (undefined)
page (integer)
per_page (integer)
post_repos_by_owner_by_repo_secret_scanning_push_protection_bypassesCreates a bypass for a previously push protected secret. The authenticated user must be the original author of the committed secret. OAuth app tokens and personal access tokens classic need the repo scope to use this endpoint.owner (string)
repo (string)
data: {
. reason (string)
. placeholder_id (string)
} (object) required
get_repos_by_owner_by_repo_secret_scanning_scan_historyLists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. !NOTE This endpoint requires GitHub Advanced Securityhttps://docs.github.com/enterprise-server@3.18/get-started/learning-about-github/about-github-advanced-security.' OAuth app tokens and personal access tokens classic need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the pubowner (string)
repo (string)
get_repos_by_owner_by_repo_stargazersLists the people that have starred the repository. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.star+json: Includes a timestamp of when the star was created.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_stats_code_frequencyReturns a weekly aggregate of the number of additions and deletions pushed to a repository.owner (string)
repo (string)
get_repos_by_owner_by_repo_stats_commit_activityReturns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.owner (string)
repo (string)
get_repos_by_owner_by_repo_stats_contributorsReturns 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 timestamphttps://en.wikipedia.org/wiki/Unix_time. a - Number of additions d - Number of deletions c - Number of commitsowner (string)
repo (string)
get_repos_by_owner_by_repo_stats_participationReturns 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. The most recent week is seven days ago at UTC midnight to today at UTC midnight.owner (string)
repo (string)
get_repos_by_owner_by_repo_stats_punch_cardEach 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.owner (string)
repo (string)
post_repos_by_owner_by_repo_statuses_by_shaUsers 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.owner (string)
repo (string)
sha (string)
data: {
. state (string)
. target_url (string)
. description (string)
. context (string)
} (object) required
get_repos_by_owner_by_repo_subscribersLists the people watching the specified repository.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_subscriptionGets information about whether the authenticated user is subscribed to the repository.owner (string)
repo (string)
put_repos_by_owner_by_repo_subscriptionIf 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 subscriptionhttps://docs.github.com/enterprise-server@3.18/rest/activity/watching delete-a-repository-subscription completely.owner (string)
repo (string)
data: {
. subscribed (boolean)
. ignored (boolean)
} (object) required
delete_repos_by_owner_by_repo_subscriptionThis 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 manuallyhttps://docs.github.com/enterprise-server@3.18/rest/activity/watching set-a-repository-subscription.owner (string)
repo (string)
get_repos_by_owner_by_repo_tagsList repository tagsowner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_tags_protection!WARNING Closing down notice: This operation is closing down and will be removed after August 30, 2024. Use the 'Repository Rulesetshttps://docs.github.com/enterprise-server@3.18/rest/repos/rules get-all-repository-rulesets' endpoint instead. This returns the tag protection states of a repository. This information is only available to repository administrators.owner (string)
repo (string)
post_repos_by_owner_by_repo_tags_protection!WARNING Closing down notice: This operation is closing down and will be removed after August 30, 2024. Use the 'Repository Rulesetshttps://docs.github.com/enterprise-server@3.18/rest/repos/rules create-a-repository-ruleset' endpoint instead. This creates a tag protection state for a repository. This endpoint is only available to repository administrators.owner (string)
repo (string)
data: {
. pattern (string)
} (object) required
delete_repos_by_owner_by_repo_tags_protection_by_tag_protection_id!WARNING Closing down notice: This operation is closing down and will be removed after August 30, 2024. Use the 'Repository Rulesetshttps://docs.github.com/enterprise-server@3.18/rest/repos/rules delete-a-repository-ruleset' endpoint instead. This deletes a tag protection state for a repository. This endpoint is only available to repository administrators.owner (string)
repo (string)
tag_protection_id (integer)
get_repos_by_owner_by_repo_tarball_by_refGets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch usually main 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.owner (string)
repo (string)
ref (string)
get_repos_by_owner_by_repo_teamsLists the teams that have access to the specified repository and that are also visible to the authenticated user. For a public repository, a team is listed only if that team added the public repository explicitly. OAuth app tokens and personal access tokens classic need the public_repo or repo scope to use this endpoint with a public repository, and repo scope to use this endpoint with a private repository.owner (string)
repo (string)
per_page (integer)
page (integer)
get_repos_by_owner_by_repo_topicsGet all repository topicsowner (string)
repo (string)
page (integer)
per_page (integer)
put_repos_by_owner_by_repo_topicsReplace all repository topicsowner (string)
repo (string)
data: {
. names (array)
} (object) required
post_repos_by_owner_by_repo_transferA 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 transfershttps://docs.github.com/enterprise-server@3.18/articles/about-repository-transfers/.owner (string)
repo (string)
data: {
. new_owner (string)
. new_name (string)
. team_ids (array)
} (object) required
get_repos_by_owner_by_repo_vulnerability_alertsShows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see 'About security alerts for vulnerable dependencieshttps://docs.github.com/enterprise-server@3.18/articles/about-security-alerts-for-vulnerable-dependencies'.owner (string)
repo (string)
put_repos_by_owner_by_repo_vulnerability_alertsEnables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see 'About security alerts for vulnerable dependencieshttps://docs.github.com/enterprise-server@3.18/articles/about-security-alerts-for-vulnerable-dependencies'.owner (string)
repo (string)
delete_repos_by_owner_by_repo_vulnerability_alertsDisables dependency alerts for a repository. The authenticated user must have admin access to the repository. For more information, see 'About security alerts for vulnerable dependencieshttps://docs.github.com/enterprise-server@3.18/articles/about-security-alerts-for-vulnerable-dependencies'.owner (string)
repo (string)
get_repos_by_owner_by_repo_zipball_by_refGets a redirect URL to download a zip archive for a repository. If you omit :ref, the repository’s default branch usually main 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. If the repository is empty, you will receive a 404 when you follow the redirect.owner (string)
repo (string)
ref (string)
post_repos_by_template_owner_by_template_repo_generateCreates 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. If the repository is not public, 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 repositoryhttps://docs.github.com/enterprise-server@3.18/rest/repos/repos get-a-repository endpoint andtemplate_owner (string)
template_repo (string)
data: {
. owner (string)
. name (string)
. description (string)
. include_all_branches (boolean)
. private (boolean)
} (object) required
get_repositoriesLists 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 headerhttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api using-link-headers to get the URL for the next page of repositories.since (integer)
visibility (string)
get_scim_v2_enterprises_by_enterprise_groups!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Lists provisioned SCIM groups in an enterprise. You can improve query search time by using the excludedAttributes query parameter with a value of members to exclude members from the response.enterprise (string)
filter (string)
excludedAttributes (string)
startIndex (integer)
count (integer)
post_scim_v2_enterprises_by_enterprise_groups!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Creates a SCIM group for an enterprise. If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.enterprise (string)
data: {
. schemas (array)
. externalId (string)
. displayName (string)
. members (array)
} (object) required
get_scim_v2_enterprises_by_enterprise_groups_by_scim_group_id!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Gets information about a SCIM group.scim_group_id (string)
enterprise (string)
excludedAttributes (string)
put_scim_v2_enterprises_by_enterprise_groups_by_scim_group_id!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group update-an-attrscim_group_id (string)
enterprise (string)
data: {
. schemas (array)
. externalId (string)
. displayName (string)
. members (array)
} (object) required
patch_scim_v2_enterprises_by_enterprise_groups_by_scim_group_id!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Update a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specificationhttps://tools.ietf.org/html/rfc7644 section-3.5.2. Update can also be used to add group mescim_group_id (string)
enterprise (string)
data: {
. Operations (array)
. schemas (array)
} (object) required
delete_scim_v2_enterprises_by_enterprise_groups_by_scim_group_id!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Deletes a SCIM group from an enterprise.scim_group_id (string)
enterprise (string)
get_scim_v2_enterprises_by_enterprise_users!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Lists provisioned SCIM enterprise members. When a user with a SCIM-provisioned external identity is removed from an enterprise through a patch with active flag set to false, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suenterprise (string)
filter (string)
startIndex (integer)
count (integer)
post_scim_v2_enterprises_by_enterprise_users!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Creates an external identity for a new SCIM enterprise user. SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The usenterprise (string)
data: {
. schemas (array)
. externalId (string)
. active (boolean)
. userName (string)
. name
. displayName (string)
. emails
. roles
} (object) required
get_scim_v2_enterprises_by_enterprise_users_by_scim_user_id!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Gets information about a SCIM user.scim_user_id (string)
enterprise (string)
put_scim_v2_enterprises_by_enterprise_users_by_scim_user_id!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user update-an-attribute-for-a-scim-enterprise-user endpointscim_user_id (string)
enterprise (string)
data: {
. schemas (array)
. externalId (string)
. active (boolean)
. userName (string)
. name
. displayName (string)
. emails
. roles
} (object) required
patch_scim_v2_enterprises_by_enterprise_users_by_scim_user_id!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Update a provisioned user's individual attributes. To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specificationhttps://tools.ietf.org/html/rfc7644 section-3.5.2. !NOTE Complicated SCIM path selectors tscim_user_id (string)
enterprise (string)
data: {
. Operations (array)
. schemas (array)
} (object) required
delete_scim_v2_enterprises_by_enterprise_users_by_scim_user_id!NOTE The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.scim_user_id (string)
enterprise (string)
get_search_codeSearches for query terms inside of a file. This method returns up to 100 results per pagehttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api. 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 metadatahttps://docs.github.com/enterprise-server@3.18/rest/search/search text-match-metadata.q (string) required
sort (string)
order (string)
per_page (integer)
page (integer)
get_search_commitsFind commits via various criteria on the default branch usually main. This method returns up to 100 results per pagehttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api. 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 metadatahttps://docs.github.com/enterprise-server@3.18/rest/search/search text-matcq (string) required
sort (string)
order (string)
per_page (integer)
page (integer)
get_search_issuesFind issues by state and keyword. This method returns up to 100 results per pagehttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api. 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 metadatahttps://docs.github.com/enterprise-server@3.18/rest/search/search text-matq (string) required
sort (string)
order (string)
per_page (integer)
page (integer)
advanced_search (string)
get_search_labelsFind labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per pagehttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api. 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 metadatahttps://docs.github.com/enterprise-server@3.18/rest/searchrepository_id (integer) required
q (string) required
sort (string)
order (string)
per_page (integer)
page (integer)
get_search_repositoriesFind repositories via various criteria. This method returns up to 100 results per pagehttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api. 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 metadatahttps://docs.github.com/enterprise-server@3.18/rest/search/search text-match-metadata. Fq (string) required
sort (string)
order (string)
per_page (integer)
page (integer)
get_search_topicsFind topics via various criteria. Results are sorted by best match. This method returns up to 100 results per pagehttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api. See 'Searching topicshttps://docs.github.com/enterprise-server@3.18/articles/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-matq (string) required
per_page (integer)
page (integer)
get_search_usersFind users via various criteria. This method returns up to 100 results per pagehttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api. When searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadatahttps://docs.github.com/enterprise-server@3.18/rest/search/search text-match-metadata. For more detailq (string) required
sort (string)
order (string)
per_page (integer)
page (integer)
get_teams_by_team_id!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by namehttps://docs.github.com/enterprise-server@3.18/rest/teams/teams get-a-team-by-name endpoint.team_id (integer)
patch_teams_by_team_id!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a teamhttps://docs.github.com/enterprise-server@3.18/rest/teams/teams 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.team_id (integer)
data: {
. name (string)
. description (string)
. privacy (string)
. notification_setting (string)
. permission (string)
. parent_team_id (integer)
} (object) required
delete_teams_by_team_id!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a teamhttps://docs.github.com/enterprise-server@3.18/rest/teams/teams 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.team_id (integer)
get_teams_by_team_id_discussions!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussionshttps://docs.github.com/enterprise-server@3.18/rest/teams/discussions list-discussions endpoint. List all discussions on a team's page. OAuth app tokens and personal access tokens classic need the read:discussion scope to use this endpoint.team_id (integer)
direction (string)
per_page (integer)
page (integer)
post_teams_by_team_id_discussions!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussionhttps://docs.github.com/enterprise-server@3.18/rest/teams/discussions create-a-discussion endpoint. Creates a new discussion post on a team's page. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-github/about-notificatiteam_id (integer)
data: {
. title (string)
. body (string)
. private (boolean)
} (object) required
get_teams_by_team_id_discussions_by_discussion_number!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussionhttps://docs.github.com/enterprise-server@3.18/rest/teams/discussions get-a-discussion endpoint. Get a specific discussion on a team's page. OAuth app tokens and personal access tokens classic need the read:discussion scope to use this endpoint.team_id (integer)
discussion_number (integer)
patch_teams_by_team_id_discussions_by_discussion_number!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussionhttps://docs.github.com/enterprise-server@3.18/rest/teams/discussions update-a-discussion endpoint. Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.team_id (integer)
discussion_number (integer)
data: {
. title (string)
. body (string)
} (object) required
delete_teams_by_team_id_discussions_by_discussion_number!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussionhttps://docs.github.com/enterprise-server@3.18/rest/teams/discussions delete-a-discussion endpoint. Delete a discussion from a team's page. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.team_id (integer)
discussion_number (integer)
get_teams_by_team_id_discussions_by_discussion_number_comments!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion commentshttps://docs.github.com/enterprise-server@3.18/rest/teams/discussion-comments list-discussion-comments endpoint. List all comments on a team discussion. OAuth app tokens and personal access tokens classic need the read:discussion scope to use this endpoint.team_id (integer)
discussion_number (integer)
direction (string)
per_page (integer)
page (integer)
post_teams_by_team_id_discussions_by_discussion_number_comments!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion commenthttps://docs.github.com/enterprise-server@3.18/rest/teams/discussion-comments create-a-discussion-comment endpoint. Creates a new comment on a team discussion. This endpoint triggers notificationshttps://docs.github.com/enterprise-server@3.18/github/managing-subscriptions-and-notifications-on-gitteam_id (integer)
discussion_number (integer)
data: {
. body (string)
} (object) required
get_teams_by_team_id_discussions_by_discussion_number_comments_by_comment_number!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion commenthttps://docs.github.com/enterprise-server@3.18/rest/teams/discussion-comments get-a-discussion-comment endpoint. Get a specific comment on a team discussion. OAuth app tokens and personal access tokens classic need the read:discussion scope to use this endpoint.team_id (integer)
discussion_number (integer)
comment_number (integer)
patch_teams_by_team_id_discussions_by_discussion_number_comments_by_comment_number!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion commenthttps://docs.github.com/enterprise-server@3.18/rest/teams/discussion-comments update-a-discussion-comment endpoint. Edits the body text of a discussion comment. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.team_id (integer)
discussion_number (integer)
comment_number (integer)
data: {
. body (string)
} (object) required
delete_teams_by_team_id_discussions_by_discussion_number_comments_by_comment_number!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion commenthttps://docs.github.com/enterprise-server@3.18/rest/teams/discussion-comments delete-a-discussion-comment endpoint. Deletes a comment on a team discussion. OAuth app tokens and personal access tokens classic need the write:discussion scope to use this endpoint.team_id (integer)
discussion_number (integer)
comment_number (integer)
get_teams_by_team_id_discussions_by_discussion_number_comments_by_comment_number_reactions!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion commenthttps://docs.github.com/enterprise-server@3.18/rest/reactions/reactions list-reactions-for-a-team-discussion-comment endpoint. List the reactions to a team discussion commenthttps://docs.github.com/enterprise-server@3.18/rest/teams/discussion-comments get-a-discussion-comment. OAteam_id (integer)
discussion_number (integer)
comment_number (integer)
content (string)
per_page (integer)
page (integer)
post_teams_by_team_id_discussions_by_discussion_number_comments_by_comment_number_reactions!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new 'Create reaction for a team discussion commenthttps://docs.github.com/enterprise-server@3.18/rest/reactions/reactions create-reaction-for-a-team-discussion-comment' endpoint. Create a reaction to a team discussion commenthttps://docs.github.com/enterprise-server@3.18/rest/teams/discussion-comments get-a-discussion-comment.team_id (integer)
discussion_number (integer)
comment_number (integer)
data: {
. content (string)
} (object) required
get_teams_by_team_id_discussions_by_discussion_number_reactions!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussionhttps://docs.github.com/enterprise-server@3.18/rest/reactions/reactions list-reactions-for-a-team-discussion endpoint. List the reactions to a team discussionhttps://docs.github.com/enterprise-server@3.18/rest/teams/discussions get-a-discussion. OAuth app tokens and personal access tokenteam_id (integer)
discussion_number (integer)
content (string)
per_page (integer)
page (integer)
post_teams_by_team_id_discussions_by_discussion_number_reactions!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussionhttps://docs.github.com/enterprise-server@3.18/rest/reactions/reactions create-reaction-for-a-team-discussion endpoint. Create a reaction to a team discussionhttps://docs.github.com/enterprise-server@3.18/rest/teams/discussions get-a-discussion. A response with an HTTP 200 status meansteam_id (integer)
discussion_number (integer)
data: {
. content (string)
} (object) required
get_teams_by_team_id_members!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team membershttps://docs.github.com/enterprise-server@3.18/rest/teams/members list-team-members endpoint. Team members will include the members of child teams.team_id (integer)
role (string)
per_page (integer)
page (integer)
get_teams_by_team_id_members_by_usernameThe 'Get team member' endpoint described below is closing down. We recommend using the Get team membership for a userhttps://docs.github.com/enterprise-server@3.18/rest/teams/members 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.team_id (integer)
username (string)
put_teams_by_team_id_members_by_usernameThe 'Add team member' endpoint described below is closing down. We recommend using the Add or update team membership for a userhttps://docs.github.com/enterprise-server@3.18/rest/teams/members 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 productshttps://docs.github.com/enterprise-server@3.18/github/geteam_id (integer)
username (string)
delete_teams_by_team_id_members_by_usernameThe 'Remove team member' endpoint described below is closing down. We recommend using the Remove team membership for a userhttps://docs.github.com/enterprise-server@3.18/rest/teams/members 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 productshttps://docs.github.com/enterprise-server@3.18/github/getting-started-team_id (integer)
username (string)
get_teams_by_team_id_memberships_by_username!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a userhttps://docs.github.com/enterprise-server@3.18/rest/teams/members 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 ofteam_id (integer)
username (string)
put_teams_by_team_id_memberships_by_username!WARNING Endpoint closing down notice: This endpoint route is closing down 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 userhttps://docs.github.com/enterprise-server@3.18/rest/teams/members 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 productshttps://docs.github.com/enterprise-server@team_id (integer)
username (string)
data: {
. role (string)
} (object) required
delete_teams_by_team_id_memberships_by_username!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a userhttps://docs.github.com/enterprise-server@3.18/rest/teams/members remove-team-membership-for-a-user endpoint. Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's productshttps://docs.github.com/enterprise-server@3.18/github/geteam_id (integer)
username (string)
get_teams_by_team_id_projects!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.team_id (integer)
per_page (integer)
page (integer)
get_teams_by_team_id_projects_by_project_id!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.team_id (integer)
project_id (integer)
put_teams_by_team_id_projects_by_project_id!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.team_id (integer)
project_id (integer)
data: {
. permission (string)
} (object) required
delete_teams_by_team_id_projects_by_project_id!WARNING Closing down notice: Projects classic is being deprecated in favor of the new Projects experience. See the changeloghttps://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/ for more information.team_id (integer)
project_id (integer)
get_teams_by_team_id_repos!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositorieshttps://docs.github.com/enterprise-server@3.18/rest/teams/teams list-team-repositories endpoint.team_id (integer)
per_page (integer)
page (integer)
get_teams_by_team_id_repos_by_owner_by_repo!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a repositoryhttps://docs.github.com/enterprise-server@3.18/rest/teams/teams check-team-permissions-for-a-repository endpoint. !NOTE Repositories inherited through a parent team will also be checked. You can also get information about the specified repository, including what permissions the teamteam_id (integer)
owner (string)
repo (string)
put_teams_by_team_id_repos_by_owner_by_repo!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new 'Add or update team repository permissionshttps://docs.github.com/enterprise-server@3.18/rest/teams/teams 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 seteam_id (integer)
owner (string)
repo (string)
data: {
. permission (string)
} (object) required
delete_teams_by_team_id_repos_by_owner_by_repo!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a teamhttps://docs.github.com/enterprise-server@3.18/rest/teams/teams 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 ateam_id (integer)
owner (string)
repo (string)
get_teams_by_team_id_teams!WARNING Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teamshttps://docs.github.com/enterprise-server@3.18/rest/teams/teams list-child-teams endpoint.team_id (integer)
per_page (integer)
page (integer)
get_userOAuth app tokens and personal access tokens classic need the user scope in order for the response to include private profile information.No parameters
patch_userNote: 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.data: {
. name (string)
. email (string)
. blog (string)
. twitter_username (string)
. company (string)
. location (string)
. hireable (boolean)
. bio (string)
} (object) required
get_user_docker_conflictsLists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint.No parameters
get_user_emailsLists all of your email addresses, and specifies which one is visible to the public. OAuth app tokens and personal access tokens classic need the user:email scope to use this endpoint.per_page (integer)
page (integer)
post_user_emailsOAuth app tokens and personal access tokens classic need the user scope to use this endpoint.data (undefined) required
delete_user_emailsOAuth app tokens and personal access tokens classic need the user scope to use this endpoint.data (undefined) required
get_user_followersLists the people following the authenticated user.per_page (integer)
page (integer)
get_user_followingLists the people who the authenticated user follows.per_page (integer)
page (integer)
get_user_following_by_usernameCheck if a person is followed by the authenticated userusername (string)
put_user_following_by_usernameNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see 'HTTP verbshttps://docs.github.com/enterprise-server@3.18/rest/guides/getting-started-with-the-rest-api http-method.' OAuth app tokens and personal access tokens classic need the user:follow scope to use this endpoint.username (string)
delete_user_following_by_usernameOAuth app tokens and personal access tokens classic need the user:follow scope to use this endpoint.username (string)
get_user_gpg_keysLists the current user's GPG keys. OAuth app tokens and personal access tokens classic need the read:gpg_key scope to use this endpoint.per_page (integer)
page (integer)
post_user_gpg_keysAdds a GPG key to the authenticated user's GitHub account. OAuth app tokens and personal access tokens classic need the write:gpg_key scope to use this endpoint.data: {
. name (string)
. armored_public_key (string)
} (object) required
get_user_gpg_keys_by_gpg_key_idView extended details for a single GPG key. OAuth app tokens and personal access tokens classic need the read:gpg_key scope to use this endpoint.gpg_key_id (integer)
delete_user_gpg_keys_by_gpg_key_idRemoves a GPG key from the authenticated user's GitHub account. OAuth app tokens and personal access tokens classic need the admin:gpg_key scope to use this endpoint.gpg_key_id (integer)
get_user_installationsLists installations of your GitHub App 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. You can find the permissions for the installation under the permissions key.per_page (integer)
page (integer)
get_user_installations_by_installation_id_repositoriesList 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. The access the user has to each repository is included in the hash under the permissions key.installation_id (integer)
per_page (integer)
page (integer)
put_user_installations_by_installation_id_repositories_by_repository_idAdd a single repository to an installation. The authenticated user must have admin access to the repository. This endpoint only works for PATs classic with the repo scope.installation_id (integer)
repository_id (integer)
delete_user_installations_by_installation_id_repositories_by_repository_idRemove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the repository_selection of selected. This endpoint only works for PATs classic with the repo scope.installation_id (integer)
repository_id (integer)
get_user_issuesList issues across owned and member repositories assigned to the authenticated user. !NOTE GitHub's REST API 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 requestshttpsfilter (string)
state (string)
labels (string)
sort (string)
direction (string)
since (string)
per_page (integer)
page (integer)
get_user_keysLists the public SSH keys for the authenticated user's GitHub account. OAuth app tokens and personal access tokens classic need the read:public_key scope to use this endpoint.per_page (integer)
page (integer)
post_user_keysAdds a public SSH key to the authenticated user's GitHub account. OAuth app tokens and personal access tokens classic need the write:public_key scope to use this endpoint.data: {
. title (string)
. key (string)
} (object) required
get_user_keys_by_key_idView extended details for a single public SSH key. OAuth app tokens and personal access tokens classic need the read:public_key scope to use this endpoint.key_id (integer)
delete_user_keys_by_key_idRemoves a public SSH key from the authenticated user's GitHub account. OAuth app tokens and personal access tokens classic need the admin:public_key scope to use this endpoint.key_id (integer)
get_user_memberships_orgsLists all of the authenticated user's organization memberships.state (string)
per_page (integer)
page (integer)
get_user_memberships_orgs_by_orgIf the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.org (string)
patch_user_memberships_orgs_by_orgConverts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.org (string)
data: {
. state (string)
} (object) required
get_user_migrationsLists all migrations a user has started.per_page (integer)
page (integer)
post_user_migrationsInitiates the generation of a user migration archive.data: {
. lock_repositories (boolean)
. exclude_metadata (boolean)
. exclude_git_data (boolean)
. exclude_attachments (boolean)
. exclude_releases (boolean)
. exclude_owner_projects (boolean)
. org_metadata_only (boolean)
. exclude (array)
. repositories (array)
} (object) required
get_user_migrations_by_migration_id_archiveFetches the URL to download the migration archive as a tar.gz file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: attachments bases commit_comments issue_comments issue_events issues milestones organizations projects protected_branches pull_request_reviews pull_requests releases repositories review_comments schema users The archive will also contain an attachments dirmigration_id (integer)
get_user_migrations_by_migration_id_repositoriesLists all the repositories for this user migration.migration_id (integer)
per_page (integer)
page (integer)
get_user_orgsList organizations for the authenticated user. For OAuth app tokens and personal access tokens classic, this endpoint 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 for OAuth app tokens and personal access tokens classic. Requests with insufficient scope will receive a 403 Forbiddenper_page (integer)
page (integer)
get_user_packagesLists packages owned by the authenticated user within the user's namespace. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'package_type (string) required
visibility (string)
page (integer)
per_page (integer)
get_user_packages_by_package_type_by_package_nameGets a specific package for a package owned by the authenticated user. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'package_type (string)
package_name (string)
delete_user_packages_by_package_type_by_package_nameDeletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. OAuth app tokens and personal access tokens classic need the read:packages and delete:packages scopes to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-forpackage_type (string)
package_name (string)
post_user_packages_by_package_type_by_package_name_restoreRestores a package owned by the authenticated user. You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. OAuthpackage_type (string)
package_name (string)
token (string)
get_user_packages_by_package_type_by_package_name_versionsLists package versions for a package owned by the authenticated user. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'package_type (string)
package_name (string)
page (integer)
per_page (integer)
state (string)
get_user_packages_by_package_type_by_package_name_versions_by_package_version_idGets a specific package version for a package owned by the authenticated user. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'package_type (string)
package_name (string)
package_version_id (integer)
delete_user_packages_by_package_type_by_package_name_versions_by_package_version_idDeletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. The authenticated user must have admin permissions in the organization to use this endpoint. OAuth app tokens and personal access tokens classic need the read:packages and delete:packages scopes to use this endpoint. For more inforpackage_type (string)
package_name (string)
package_version_id (integer)
post_user_packages_by_package_type_by_package_name_versions_by_package_version_id_restoreRestores a package version owned by the authenticated user. You can restore a deleted package version under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespacpackage_type (string)
package_name (string)
package_version_id (integer)
get_user_public_emailsLists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated userhttps://docs.github.com/enterprise-server@3.18/rest/users/emails set-primary-email-visibility-for-the-authenticated-user endpoint. OAuth app tokens and personal access tokens classic need the user:email scope to use this endpoint.per_page (integer)
page (integer)
get_user_reposLists 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.visibility (string)
affiliation (string)
type (string)
sort (string)
direction (string)
per_page (integer)
page (integer)
since (string)
before (string)
post_user_reposCreates a new repository for the authenticated user. OAuth app tokens and personal access tokens classic need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.data: {
. name (string)
. description (string)
. homepage (string)
. private (boolean)
. has_issues (boolean)
. has_projects (boolean)
. has_wiki (boolean)
. has_discussions (boolean)
. team_id (integer)
. auto_init (boolean)
. gitignore_template (string)
. license_template (string)
. allow_squash_merge (boolean)
. allow_merge_commit (boolean)
. allow_rebase_merge (boolean)
. allow_auto_merge (boolean)
. delete_branch_on_merge (boolean)
. squash_merge_commit_title (string)
. squash_merge_commit_message (string)
. merge_commit_title (string)
. merge_commit_message (string)
. has_downloads (boolean)
. is_template (boolean)
} (object) required
get_user_repository_invitationsWhen authenticating as a user, this endpoint will list all currently open repository invitations for that user.per_page (integer)
page (integer)
patch_user_repository_invitations_by_invitation_idAccept a repository invitationinvitation_id (integer)
delete_user_repository_invitations_by_invitation_idDecline a repository invitationinvitation_id (integer)
get_user_social_accountsLists all of your social accounts.per_page (integer)
page (integer)
post_user_social_accountsAdd one or more social accounts to the authenticated user's profile. OAuth app tokens and personal access tokens classic need the user scope to use this endpoint.data: {
. account_urls (array)
} (object) required
delete_user_social_accountsDeletes one or more social accounts from the authenticated user's profile. OAuth app tokens and personal access tokens classic need the user scope to use this endpoint.data: {
. account_urls (array)
} (object) required
get_user_ssh_signing_keysLists the SSH signing keys for the authenticated user's GitHub account. OAuth app tokens and personal access tokens classic need the read:ssh_signing_key scope to use this endpoint.per_page (integer)
page (integer)
post_user_ssh_signing_keysCreates an SSH signing key for the authenticated user's GitHub account. OAuth app tokens and personal access tokens classic need the write:ssh_signing_key scope to use this endpoint.data: {
. title (string)
. key (string)
} (object) required
get_user_ssh_signing_keys_by_ssh_signing_key_idGets extended details for an SSH signing key. OAuth app tokens and personal access tokens classic need the read:ssh_signing_key scope to use this endpoint.ssh_signing_key_id (integer)
delete_user_ssh_signing_keys_by_ssh_signing_key_idDeletes an SSH signing key from the authenticated user's GitHub account. OAuth app tokens and personal access tokens classic need the admin:ssh_signing_key scope to use this endpoint.ssh_signing_key_id (integer)
get_user_starredLists repositories the authenticated user has starred. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.star+json: Includes a timestamp of when the star was created.sort (string)
direction (string)
per_page (integer)
page (integer)
get_user_starred_by_owner_by_repoWhether the authenticated user has starred the repository.owner (string)
repo (string)
put_user_starred_by_owner_by_repoNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see 'HTTP methodhttps://docs.github.com/enterprise-server@3.18/rest/guides/getting-started-with-the-rest-api http-method.'owner (string)
repo (string)
delete_user_starred_by_owner_by_repoUnstar a repository that the authenticated user has previously starred.owner (string)
repo (string)
get_user_subscriptionsLists repositories the authenticated user is watching.per_page (integer)
page (integer)
get_user_teamsList all of the teams across all of the organizations to which the authenticated user belongs. OAuth app tokens and personal access tokens classic need the user, repo, or read:org scope to use this endpoint. When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.per_page (integer)
page (integer)
get_user_by_account_idProvides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time. The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile pagehttps://github.com/settings/profile. 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 addraccount_id (integer)
get_usersLists 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 headerhttps://docs.github.com/enterprise-server@3.18/rest/guides/using-pagination-in-the-rest-api using-link-headers to get the URL for the next page of users.since (integer)
per_page (integer)
get_users_by_usernameProvides publicly available information about someone with a GitHub account. The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile pagehttps://github.com/settings/profile. 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 addresusername (string)
get_users_by_username_docker_conflictsLists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint.username (string)
get_users_by_username_eventsIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: 'Events' user permissions read. !NOTE This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.username (string)
per_page (integer)
page (integer)
get_users_by_username_events_orgs_by_orgThis is the user's organization dashboard. You must be authenticated as the user to view this. !NOTE This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.username (string)
org (string)
per_page (integer)
page (integer)
get_users_by_username_events_public!NOTE This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.username (string)
per_page (integer)
page (integer)
get_users_by_username_followersLists the people following the specified user.username (string)
per_page (integer)
page (integer)
get_users_by_username_followingLists the people who the specified user follows.username (string)
per_page (integer)
page (integer)
get_users_by_username_following_by_target_userCheck if a user follows another userusername (string)
target_user (string)
get_users_by_username_gistsLists public gists for the specified user:username (string)
since (string)
per_page (integer)
page (integer)
get_users_by_username_gpg_keysLists the GPG keys for a user. This information is accessible by anyone.username (string)
per_page (integer)
page (integer)
get_users_by_username_hovercardProvides hovercard information. 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, you would use a subject_type value of repository and a subject_id value of 1300192 the ID of the Spoon-Knife rusername (string)
subject_type (string)
subject_id (string)
get_users_by_username_installationEnables an authenticated GitHub App to find the user’s installation information. You must use a JWThttps://docs.github.com/enterprise-server@3.18/apps/building-github-apps/authenticating-with-github-apps/ authenticating-as-a-github-app to access this endpoint.username (string)
get_users_by_username_keysLists the verified public SSH keys for a user. This is accessible by anyone.username (string)
per_page (integer)
page (integer)
get_users_by_username_orgsList public organization membershipshttps://docs.github.com/enterprise-server@3.18/articles/publicizing-or-concealing-organization-membership 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 userhttps://docs.github.com/enterprise-server@3.18/rest/orgs/orgs list-organizations-for-the-authenticateusername (string)
per_page (integer)
page (integer)
get_users_by_username_packagesLists all packages in a user's namespace for which the requesting user has access. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'username (string)
package_type (string) required
visibility (string)
page (integer)
per_page (integer)
get_users_by_username_packages_by_package_type_by_package_nameGets a specific package metadata for a public package owned by a user. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'package_type (string)
package_name (string)
username (string)
delete_users_by_username_packages_by_package_type_by_package_nameDeletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-gpackage_type (string)
package_name (string)
username (string)
post_users_by_username_packages_by_package_type_by_package_name_restoreRestores an entire package for a user. You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. If the package_typepackage_type (string)
package_name (string)
username (string)
token (string)
get_users_by_username_packages_by_package_type_by_package_name_versionsLists package versions for a public package owned by a specified user. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'package_type (string)
package_name (string)
username (string)
get_users_by_username_packages_by_package_type_by_package_name_versions_by_package_version_idGets a specific package version for a public package owned by a specified user. OAuth app tokens and personal access tokens classic need the read:packages scope to use this endpoint. For more information, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprise-server@3.18/packages/learn-github-packages/about-permissions-for-github-packages permissions-for-repository-scoped-packages.'package_type (string)
package_name (string)
package_version_id (integer)
username (string)
delete_users_by_username_packages_by_package_type_by_package_name_versions_by_package_version_idDeletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see 'About permissions for GitHub Packageshttps://docs.github.com/enterprpackage_type (string)
package_name (string)
username (string)
package_version_id (integer)
post_users_by_username_packages_by_package_type_by_package_name_versions_by_package_version_id_restoreRestores a specific package version for a user. You can restore a deleted package under the following conditions: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. If the pacpackage_type (string)
package_name (string)
username (string)
package_version_id (integer)
get_users_by_username_received_eventsThese are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. !NOTE This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.username (string)
per_page (integer)
page (integer)
get_users_by_username_received_events_public!NOTE This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.username (string)
per_page (integer)
page (integer)
get_users_by_username_reposLists public repositories for the specified user.username (string)
type (string)
sort (string)
direction (string)
per_page (integer)
page (integer)
put_users_by_username_site_adminNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see 'HTTP methodhttps://docs.github.com/enterprise-server@3.18/rest/guides/getting-started-with-the-rest-api http-method.'username (string)
delete_users_by_username_site_adminYou can demote any user account except your own.username (string)
get_users_by_username_social_accountsLists social media accounts for a user. This endpoint is accessible by anyone.username (string)
per_page (integer)
page (integer)
get_users_by_username_ssh_signing_keysLists the SSH signing keys for a user. This operation is accessible by anyone.username (string)
per_page (integer)
page (integer)
get_users_by_username_starredLists repositories a user has starred. This endpoint supports the following custom media types. For more information, see 'Media typeshttps://docs.github.com/enterprise-server@3.18/rest/using-the-rest-api/getting-started-with-the-rest-api media-types.' - application/vnd.github.star+json: Includes a timestamp of when the star was created.username (string)
sort (string)
direction (string)
per_page (integer)
page (integer)
get_users_by_username_subscriptionsLists repositories a user is watching.username (string)
per_page (integer)
page (integer)
put_users_by_username_suspendedIf your GitHub instance uses LDAP Sync with Active Directory LDAP servershttps://docs.github.com/enterprise-server@3.18/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap, 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 parameterusername (string)
data: {
. reason (string)
} (object) required
delete_users_by_username_suspendedIf your GitHub instance uses LDAP Sync with Active Directory LDAP servershttps://docs.github.com/enterprise-server@3.18/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.username (string)
data: {
. reason (string)
} (object) required
get_zenGet a random sentence from the Zen of GitHubNo parameters