Search
K
GitHub v3 REST API

Get GitHub Enterprise Server meta information

get
http://HOSTNAME/api/v3/meta

Response

application/json

Response

Api Overview

Api Overview

verifiable_password_authenticationbooleanrequired

Example:true

packagesarray[string]

Example:["13.65.0.0/16","157.55.204.33/32","2a01:111:f403:f90c::/62"]

dependabotarray[string]

Example:["192.168.7.15/32","192.168.7.16/32"]

installed_versionstring

Example:3.0.0

get/meta
 
application/json

Get Octocat

Get the octocat as ASCII art

get
http://HOSTNAME/api/v3/octocat

Query Parameters

sstring

The words to show in Octocat’s speech bubble

Response

200 application/octocat-stream

Response

string
get/octocat
 
200 application/octocat-stream

Get the Zen of GitHub

Get a random sentence from the Zen of GitHub

get
http://HOSTNAME/api/v3/zen

Response

200 text/plain

Response

string
get/zen
 
200 text/plain

List your grants

DEPRECATED

Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return ["repo", "user"].

get
http://HOSTNAME/api/v3/applications/grants

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

client_idstring

The client ID of your GitHub app.

Response

application/json

Response

The authorization associated with an OAuth Access.

idintegerrequired

Example:1

urlstring(uri)required

Example:https://api.github.com/applications/grants/1

appobjectrequired
Show Child Parameters
created_atstring(date-time)required

Example:2011-09-06T17:26:27Z

updated_atstring(date-time)required

Example:2011-09-06T20:39:23Z

scopesarray[string]required

Example:["public_repo"]

userobject | null

Simple User

Show Child Parameters
get/applications/grants
 
application/json

Get a single grant

DEPRECATED

Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.

get
http://HOSTNAME/api/v3/applications/grants/{grant_id}

Path Parameters

grant_idintegerrequired

grant_id parameter

Response

application/json

Response

Application Grant

The authorization associated with an OAuth Access.

idintegerrequired

Example:1

urlstring(uri)required

Example:https://api.github.com/applications/grants/1

appobjectrequired
Show Child Parameters
created_atstring(date-time)required

Example:2011-09-06T17:26:27Z

updated_atstring(date-time)required

Example:2011-09-06T20:39:23Z

scopesarray[string]required

Example:["public_repo"]

userobject | null

Simple User

Show Child Parameters
get/applications/grants/{grant_id}
 
application/json