Sample - GitHub REST API
GET/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps

Get apps with access to the protected branch

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

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

3 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.
branchstringrequired
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).

2 status codes
200Response
idintegerrequired
Unique identifier of the GitHub app
slugstringoptional
The slug name of the GitHub app
node_idstringrequired
client_idstringoptional
ownerobjectrequired
A GitHub user.
namestringrequired
The name of the GitHub app
descriptionstringrequired
external_urlstringrequired
html_urlstringrequired
created_atstringrequired
updated_atstringrequired
permissionsobjectrequired
The set of permissions for the GitHub app
eventsarray<string>required
The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
installations_countintegeroptional
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned: Resource not found.