Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
List repositories that the authenticated user has explicit permission (:read
, :write
, or :admin
) to access for an installation.
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 must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint.
The access the user has to each repository is included in the hash under the permissions
key.
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
installation_id parameter
The access the user has to each repository is included in the hash under the permissions
key.
A git repository
Add a single repository to an installation. The authenticated user must have admin access to the repository.
You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.
installation_id parameter
Response
Remove a single repository from an installation. The authenticated user must have admin access to the repository.
You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.
installation_id parameter
Response
Enables an authenticated GitHub App to find the user’s installation information.
You must use a JWT to access this endpoint.
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"
Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests
array.
Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write
permission to create check runs.
In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
One Of
Allowed values:completed
Response
A check performed on the code of a given code change
The id of the check.
Example:21
The SHA of the commit that is being checked.
Example:009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
Example:MDg6Q2hlY2tSdW40
Example:42
Example:https://api.github.com/repos/github/hello-world/check-runs/4
Example:https://github.com/github/hello-world/runs/4
Example:https://example.com
The phase of the lifecycle that the check is currently in.
Allowed values:queuedin_progresscompleted
Example:queued
Allowed values:successfailureneutralcancelledskippedtimed_outaction_required
Example:neutral
Example:2018-05-04T01:14:52Z
Example:2018-05-04T01:14:52Z
The name of the check.
Example:test-coverage
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
A deployment created as the result of an Actions check run from a workflow that references an environment