Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
You must use a JWT to access this endpoint.
The permissions the installation has are included under the permissions
key.
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
.
The permissions the installation has are included under the permissions
key.
Installation
The ID of the installation.
Example:1
Any Of
Simple User
Describe whether all repositories have been selected or there’s a selection involved
Allowed values:allselected
Example:https://api.github.com/installations/1/access_tokens
Example:https://api.github.com/installation/repositories
Example:https://github.com/organizations/github/settings/installations/1
Example:1
The ID of the user or organization this token is being scoped to.
Example:Organization
The permissions granted to the user-to-server access token.
Example:{"contents":"read","issues":"read","deployments":"write","single_file":"read"}
Example:config.yaml
Example:true
Example:["config.yml",".github/issue_TEMPLATE.md"]
Example:github-actions
Simple User
Example:"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"
Enables an authenticated GitHub App to find an installation’s information using the installation id.
You must use a JWT to access this endpoint.
installation_id parameter
Response
Installation
The ID of the installation.
Example:1
Any Of
Simple User
Describe whether all repositories have been selected or there’s a selection involved
Allowed values:allselected
Example:https://api.github.com/installations/1/access_tokens
Example:https://api.github.com/installation/repositories
Example:https://github.com/organizations/github/settings/installations/1
Example:1
The ID of the user or organization this token is being scoped to.
Example:Organization
The permissions granted to the user-to-server access token.
Example:{"contents":"read","issues":"read","deployments":"write","single_file":"read"}
Example:config.yaml
Example:true
Example:["config.yml",".github/issue_TEMPLATE.md"]
Example:github-actions
Simple User
Example:"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"
Uninstalls 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.
installation_id parameter
Response
Creates 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.
installation_id parameter
List of repository names that the token should have access to
Example:rails
List of repository IDs that the token should have access to
Example:[1]
The permissions granted to the user-to-server access token.
Example:{"contents":"read","issues":"read","deployments":"write","single_file":"read"}
Response
Authentication token for a GitHub App installed on a user or org.
The permissions granted to the user-to-server access token.
Example:{"contents":"read","issues":"read","deployments":"write","single_file":"read"}
Allowed values:allselected
A git repository
Example:README.md
Example:true
Example:["config.yml",".github/issue_TEMPLATE.md"]
Suspends 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 Enterprise Server API or webhook events is blocked for that account.
You must use a JWT to access this endpoint.
installation_id parameter
Response