Sample - GitHub REST API
GET/repos/{owner}/{repo}/installation

Get a repository installation for the authenticated app

Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

You must use a JWT to access this endpoint.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.

3 status codes
200Response
idintegerrequired
The ID of the installation.
accountobjectrequired
A GitHub user.
repository_selectionstringrequired
Describe whether all repositories have been selected or there's a selection involved
Allowed:allselected
access_tokens_urlstringrequired
repositories_urlstringrequired
html_urlstringrequired
app_idintegerrequired
client_idstringoptional
target_idintegerrequired
The ID of the user or organization this token is being scoped to.
target_typestringrequired
permissionsobjectrequired
The permissions granted to the fine-grained access token.
eventsarray<string>required
created_atstringrequired
updated_atstringrequired
single_file_namestringrequired
has_multiple_single_filesbooleanoptional
single_file_pathsarray<string>optional
app_slugstringrequired
suspended_byobjectrequired
A GitHub user.
suspended_atstringrequired
contact_emailstringoptional
301Moved permanently
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned: Resource not found.