What's my GitHub appliance's REST API endpoint?

github-api
Jirong Hu picture Jirong Hu · Apr 8, 2016 · Viewed 14.1k times · Source

I want to use Groovy, HttpBuilder and REST API to access our company's onsidte GitHub appliance. The GitHub developer's site: https://developer.github.com/v3/, shows this URL: https://api.github.com. So if my company's GitHub URL is: http://github.mycompany.com, what is my REST API endpoint URL? e.g. if I want to list all users, what's the correct URL?

When I access this URL: https://github.mycompany.com/api/v3, it gives me an error:

github.mycompany.com refused to connect. ERR_CONNECTION_REFUSED

Answer

VonC picture VonC · Apr 9, 2016

According to "API Enterprise 2.5":

All API endpoints—except Management Console API endpoints—are prefixed with the following URL:

http(s)://hostname/api/v3/

But you need to authenticate:

Authentication

Your Enterprise installation's API endpoints accept the same authentication methods as the GitHub.com API. Specifically, you can authenticate yourself with OAuth tokens (which can be created using the Authorizations API) or basic authentication.

Every Enterprise API endpoint is only accessible to GitHub Enterprise site administrators, with the exception of the Management Console API, which is only accessible via the Management Console password.

Related questions

Use Invoke-WebRequest with a username and password for basic authentication on the GitHub API

With cURL, we can pass a username with an HTTP web request as follows: $ curl -u <your_username> https://api.github.com/user The -u flag accepts a username for authentication, and then cURL will request the password. …

Read More
Git cli: get user info from username

Is there a way to get the name of the user, given only their username? Something like this output git show <username> (I know this doesn't work) username: username name: First Last email: email@address I know I …

Read More
How can I see the size of a GitHub repository before cloning it?

Is there a way to see how big a Git repository is on GitHub before you decide to clone it? This seems like a really obvious/basic statistic, but I can't find how to see it on GitHub at all.

Read More