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

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

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

```shell
{% data variables.product.rest_url %}
```

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

```shell
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](/rest/overview/authenticating-to-the-rest-api).

OAuth tokens must have the `site_admin` [OAuth scope](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes) 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](/rest/enterprise-admin/manage-ghes) API{% ifversion ghes < 3.15 %} and [AUTOTITLE](/rest/enterprise-admin/management-console) API{% endif %}, which allow authentication as a Management Console user. See [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console).

{% 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](/rest/meta).

{% endif %}

## Endpoints

<!-- Content after this section is automatically generated -->