installations

Creates, updates, deletes, gets or lists an installations resource.

Overview

Name	installations
Type	Resource
Id	github.apps.installations

Fields

The following fields are returned by SELECT queries:

list_installations_for_authenticated_user

You can find the permissions for the installation under the permissions key.

Name	Datatype	Description
id	integer	The ID of the installation.
app_id	integer
client_id	string	(example: Iv1.ab1112223334445c)
target_id	integer	The ID of the user or organization this token is being scoped to.
single_file_name	string	(example: config.yaml)
access_tokens_url	string (uri)	(example: https://api.github.com/app/installations/1/access_tokens)
account	object	A GitHub user. (title: Simple User)
app_slug	string	(example: github-actions)
contact_email	string	(example: "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com")
created_at	string (date-time)
events	array
has_multiple_single_files	boolean
html_url	string (uri)	(example: https://github.com/organizations/github/settings/installations/1)
permissions	object	The permissions granted to the user access token. (title: App Permissions)
repositories_url	string (uri)	(example: https://api.github.com/installation/repositories)
repository_selection	string	Describe whether all repositories have been selected or there's a selection involved (all, selected)
single_file_paths	array
suspended_at	string (date-time)
suspended_by	object	A GitHub user. (title: Simple User)
target_type	string	(example: Organization)
updated_at	string (date-time)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_installations_for_authenticated_user	select		per_page, page	Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access. The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. You can find the permissions for the installation under the permissions key.
revoke_installation_access_token	delete			Revokes the installation token you're using to authenticate as an installation and access this endpoint. Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "Create an installation access token for an app" endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

list_installations_for_authenticated_user

Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You can find the permissions for the installation under the permissions key.

SELECT
id,
app_id,
client_id,
target_id,
single_file_name,
access_tokens_url,
account,
app_slug,
contact_email,
created_at,
events,
has_multiple_single_files,
html_url,
permissions,
repositories_url,
repository_selection,
single_file_paths,
suspended_at,
suspended_by,
target_type,
updated_at
FROM github.apps.installations
WHERE per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

DELETE examples

revoke_installation_access_token

Revokes the installation token you're using to authenticate as an installation and access this endpoint.

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "Create an installation access token for an app" endpoint.

DELETE FROM github.apps.installations
;