title:Enterprise | GitHub API

* TOC

{:toc}

GitHub Enterprise supports the same powerful API available on GitHub.com as well as its own set of API endpoints:

- Use the[Admin Stats][] API to get usage statistics

- Use the[License][] API to get license information

- Use the[Search Indexing][] API to queue up search indexing jobs

- Use the[Management Console][] API to perform common administrative tasks

[Admin Stats]:admin_stats/

[License]:license/

[Search Indexing]:search_indexing/

[Management Console]:management_console/

Every endpoint used by the GitHub API depends on your`hostname`, which is the name of your Enterprise installation.

Endpoints for the GitHub.com API and most of the Enterprise API start with the following URL:

<preclass="terminal">

http(s)://<em>hostname</em>/api/v3/

</pre>

Endpoints for the[Search Indexing][] API start with the following URL:

<preclass="terminal">

http(s)://<em>hostname</em>/api/v3/staff/

</pre>

Endpoints for the[Management Console][] API start with the following URL:

<preclass="terminal">

http(s)://<em>hostname</em>/setup/api/

</pre>

If your Enterprise host name is`ghe.local`, a call to[the Issues API](/v3/issues/) would be made to`https://ghe.local/api/v3/issues`.

Your Enterprise installation's API endpoints accept[the same authentication methods](http://developer.github.com/v3/#authentication) as the GitHub.com API. Specifically, you can authenticate yourself with**[OAuth tokens][]** (which can be created using the[Authorizations API][]) or**[basic authentication][]**.

[OAuth tokens]:/v3/oauth/

[basic authentication]:/v3/#basic-authentication

The[Admin Stats][],[License][], and[Search Indexing][] API endpoints are only accessible to GitHub Enterprise site admins. The[Management Console][] API endpoints are accessible to anyone with a valid license file.

[Authorizations API]:/v3/oauth_authorizations/#create-a-new-authorization

title:Admin Stats | GitHub API

* TOC

{:toc}

The Admin Stats API provides a variety of metrics about your installation.*It is only available to site admins.* Normal users will receive a`404` response if they try to access it.

There are a variety of types to choose from:

Type | Description

-------------|-------------------------------------

`issues` | The number of open and closed issues.

`hooks` | The number of active and inactive hooks.

`milestones` | The number of open and closed milestones.

`orgs` | The number of organizations, teams, team members, and disabled organizations.

`comments` | The number of comments on issues, pull requests, commits, and gists.

`pages` | The number of GitHub Pages sites.

`users` | The number of suspended and admin users.

`gists` | The number of private and public gists.

`pulls` | The number of merged, mergeable, and unmergeable pull requests.

`repos` | The number of organization-owned repositories, root repositories, forks, pushed commits, and wikis.

`all` | All of the statistics listed above.

These statistics are cached and will be updated approximately every 10 minutes.

<%= headers 200 %>

<%= json(:admin_stats) %>

title:License | GitHub API

* TOC

{:toc}

The License API provides information on your Enterprise license.*It is only available to site admins.* Normal users will receive a`404` response if they try to access it.

<%= headers 200 %>

<%= json(:licensing) %>