Skip to content

Latest commit

 

History

History
96 lines (72 loc) · 3.32 KB

index.md

File metadata and controls

96 lines (72 loc) · 3.32 KB
title intro allowTitleToDifferFromFilename redirect_from versions topics shortTitle children autogenerated
REST API endpoints for GitHub Enterprise administration
Use the REST API to administer your enterprise.
true
/v3/enterprise-admin
/v3/enterprise
/rest/reference/enterprise-admin
ghes ghec
*
*
API
Enterprise administration
/admin-stats
/announcement
/audit-log
/billing
/bypass-requests
/code-security-and-analysis
/custom-properties
/global-webhooks
/ldap
/license
/manage-ghes
/management-console
/network-configurations
/org-pre-receive-hooks
/orgs
/pre-receive-environments
/pre-receive-hooks
/repo-pre-receive-hooks
/rules
/scim
/users
rest

{% ifversion fpt or ghec %}

Note

This information applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_server %} version, use the {% data ui.pages.article_version %} drop-down menu.

{% endif %}

{% data reusables.user-settings.enterprise-admin-api-classic-pat-only %}

Endpoint URLs

These endpoints{% ifversion ghes %}, except the Manage GitHub Enterprise Server API {% ifversion ghes < 3.15 %} and Management Console API{% endif %},{% endif %} are prefixed with the following URL:

{% data variables.product.rest_url %}

{% ifversion fpt or ghec %} When endpoints include {enterprise}, replace {enterprise} with the handle for your enterprise account, which is included in the URL for your enterprise settings. For example, if your enterprise account is located at https://github.com/enterprises/octo-enterprise, replace {enterprise} with octo-enterprise. {% endif %}

{% ifversion ghes %}

Endpoints for the Manage GitHub Enterprise Server API{% ifversion ghes < 3.15 %} and Management Console API{% endif %} are only prefixed with a hostname and administration port:

http(s)://HOSTNAME:ADMINISTRATION-PORT/

{% endif %} {% ifversion ghes %}

Authentication

Your {% data variables.product.prodname_ghe_server %} installation's API endpoints accept the same authentication methods as the {% data variables.product.github %} API. For more information, see AUTOTITLE.

OAuth tokens must have the site_admin OAuth scope when used with these endpoints.

These endpoints are only accessible to authenticated {% data variables.product.prodname_ghe_server %} site administrators, except for endpoints of the AUTOTITLE API{% ifversion ghes < 3.15 %} and AUTOTITLE API{% endif %}, which allow authentication as a Management Console user. See AUTOTITLE.

{% data reusables.enterprise_management_console.api-deprecation %}

{% endif %}

{% ifversion ghes %}

Version information

The current version of your enterprise is returned in the REST API response header: X-GitHub-Enterprise-Version: {{currentVersion}}.0 You can also read the current version by calling GET /meta. For more information, see AUTOTITLE.

{% endif %}

Endpoints