Skip to main content

installations

Overview

Nameinstallations
TypeResource
Idgithub.apps.installations

Fields

NameDatatypeDescription
idintegerThe ID of the installation.
suspended_byobjectSimple User
permissionsobjectThe permissions granted to the user-to-server access token.
single_file_pathsarray
updated_atstring
repositories_urlstring
account``
repository_selectionstringDescribe whether all repositories have been selected or there's a selection involved
created_atstring
target_typestring
single_file_namestring
contact_emailstring
access_tokens_urlstring
app_idinteger
target_idintegerThe ID of the user or organization this token is being scoped to.
html_urlstring
suspended_atstring
has_multiple_single_filesboolean
eventsarray
app_slugstring

Methods

NameAccessible byRequired ParamsDescription
get_installationSELECTinstallation_idEnables an authenticated GitHub App to find an installation's information using the installation id.

You must use a JWT to access this endpoint.
get_org_installationSELECTorgEnables an authenticated GitHub App to find the organization's installation information.

You must use a JWT to access this endpoint.
get_repo_installationSELECTowner, repoEnables 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.
list_installationsSELECTYou must use a JWT to access this endpoint.

The permissions the installation has are included under the permissions key.
delete_installationDELETEinstallation_idUninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "Suspend an app installation" endpoint.

You must use a JWT to access this endpoint.
create_installation_access_tokenEXECinstallation_idCreates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key.

You must use a JWT to access this endpoint.
suspend_installationEXECinstallation_idSuspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.

You must use a JWT to access this endpoint.
unsuspend_installationEXECinstallation_idRemoves a GitHub App installation suspension.

You must use a JWT to access this endpoint.