docs/content/rest/enterprise-admin/index.md

title, intro, allowTitleToDifferFromFilename, redirect_from, versions, topics, shortTitle, children, autogenerated

title	intro	allowTitleToDifferFromFilename	redirect_from	versions	topics	shortTitle	children	autogenerated
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 /code-security-and-analysis /global-webhooks /ldap /license /manage-ghes /management-console /org-pre-receive-hooks /orgs /pre-receive-environments /pre-receive-hooks /repo-pre-receive-hooks /scim /users	rest

{% ifversion fpt or ghec %}

{% note %}

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.

{% endnote %}

{% endif %}

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

Endpoint URLs

These endpoints{% ifversion ghes %}—except Management Console endpoints—{% endif %} are prefixed with the following URL:

{% data variables.product.api_url_pre %}

{% 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 %} Management Console endpoints are only prefixed with a hostname:

http(s)://HOSTNAME/

{% endif %} {% ifversion ghes %}

Authentication

Your {% data variables.product.product_name %} installation's API endpoints accept the same authentication methods as the {% data variables.product.prodname_dotcom %} 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.product_name %} site administrators, except for the Management Console endpoints, which requires the Management Console password.

{% 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