Pontos de extremidade da API REST para o GitHub Apps
Usar a API REST para interagir com o GitHub Apps
Sobre os GitHub Apps
Esta página lista pontos de extremidade que você pode acessar enquanto está autenticado como um GitHub App. Para obter mais informações, confira "Efetuar autenticação como um aplicativo GitHub".
Confira "Pontos de extremidade da API REST para instalações do GitHub App" para obter uma lista de pontos de extremidade que exigem autenticação como uma instalação do GitHub App.
Get the authenticated app
Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count
in the response. For more details about your app's installations, see the "List installations for the authenticated app" endpoint.
You must use a JWT to access this endpoint.
Tokens de acesso refinados para "Get the authenticated app"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Códigos de status de resposta HTTP para "Get the authenticated app"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get the authenticated app"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/app
Response
Status: 200
{
"id": 1,
"slug": "octoapp",
"client_id": "Iv1.ab1112223334445c",
"node_id": "MDExOkludGVncmF0aW9uMQ==",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"name": "Octocat App",
"description": "",
"external_url": "https://example.com",
"html_url": "https://github.com/apps/octoapp",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"permissions": {
"metadata": "read",
"contents": "read",
"issues": "write",
"single_file": "write"
},
"events": [
"push",
"pull_request"
]
}
Create a GitHub App from a manifest
Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code
used to retrieve the GitHub App's id
, pem
(private key), and webhook_secret
.
Tokens de acesso refinados para "Create a GitHub App from a manifest"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Create a GitHub App from a manifest"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
code string Obrigatório |
Códigos de status de resposta HTTP para "Create a GitHub App from a manifest"
Código de status | Descrição |
---|---|
201 | Created |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Create a GitHub App from a manifest"
Exemplo de solicitação
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/app-manifests/CODE/conversions
Response
Status: 201
{
"id": 1,
"slug": "octoapp",
"node_id": "MDxOkludGVncmF0aW9uMQ==",
"owner": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://HOSTNAME/orgs/github",
"repos_url": "https://HOSTNAME/orgs/github/repos",
"events_url": "https://HOSTNAME/orgs/github/events",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": true
},
"name": "Octocat App",
"description": "",
"external_url": "https://example.com",
"html_url": "https://github.com/apps/octoapp",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"permissions": {
"metadata": "read",
"contents": "read",
"issues": "write",
"single_file": "write"
},
"events": [
"push",
"pull_request"
],
"client_id": "Iv1.8a61f9b3a7aba766",
"client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8",
"webhook_secret": "e340154128314309424b7c8e90325147d99fdafa",
"pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n"
}
List installation requests for the authenticated app
Lists all the pending installation requests for the authenticated GitHub App.
Tokens de acesso refinados para "List installation requests for the authenticated app"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "List installation requests for the authenticated app"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: |
Códigos de status de resposta HTTP para "List installation requests for the authenticated app"
Código de status | Descrição |
---|---|
200 | List of integration installation requests |
304 | Not modified |
401 | Requires authentication |
Exemplos de código para "List installation requests for the authenticated app"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/app/installation-requests
List of integration installation requests
Status: 200
[
{
"id": 25381,
"node_id": "MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA==",
"account": {
"login": "octo-org",
"id": 6811672,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=",
"avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octo-org",
"html_url": "https://github.com/octo-org",
"followers_url": "https://HOSTNAME/users/octo-org/followers",
"following_url": "https://HOSTNAME/users/octo-org/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octo-org/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octo-org/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octo-org/subscriptions",
"organizations_url": "https://HOSTNAME/users/octo-org/orgs",
"repos_url": "https://HOSTNAME/users/octo-org/repos",
"events_url": "https://HOSTNAME/users/octo-org/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octo-org/received_events",
"type": "Organization",
"site_admin": false
},
"requester": {
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"created_at": "2022-07-08T16:18:44-04:00"
}
]
List installations for the authenticated app
The permissions the installation has are included under the permissions
key.
You must use a JWT to access this endpoint.
Tokens de acesso refinados para "List installations for the authenticated app"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "List installations for the authenticated app"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: |
since string Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format: |
outdated string |
Códigos de status de resposta HTTP para "List installations for the authenticated app"
Código de status | Descrição |
---|---|
200 | The permissions the installation has are included under the |
Exemplos de código para "List installations for the authenticated app"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/app/installations
The permissions the installation has are included under the permissions
key.
Status: 200
[
{
"id": 1,
"account": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"access_tokens_url": "https://HOSTNAME/app/installations/1/access_tokens",
"repositories_url": "https://HOSTNAME/installation/repositories",
"html_url": "https://github.com/organizations/github/settings/installations/1",
"app_id": 1,
"target_id": 1,
"target_type": "Organization",
"permissions": {
"checks": "write",
"metadata": "read",
"contents": "read"
},
"events": [
"push",
"pull_request"
],
"single_file_name": "config.yaml",
"has_multiple_single_files": true,
"single_file_paths": [
"config.yml",
".github/issue_TEMPLATE.md"
],
"repository_selection": "selected",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
]
Get an installation for the authenticated app
Enables an authenticated GitHub App to find an installation's information using the installation id.
You must use a JWT to access this endpoint.
Tokens de acesso refinados para "Get an installation for the authenticated app"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Get an installation for the authenticated app"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
installation_id integer ObrigatórioThe unique identifier of the installation. |
Códigos de status de resposta HTTP para "Get an installation for the authenticated app"
Código de status | Descrição |
---|---|
200 | OK |
404 | Resource not found |
Exemplos de código para "Get an installation for the authenticated app"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/app/installations/1
Response
Status: 200
{
"id": 1,
"account": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"access_tokens_url": "https://HOSTNAME/app/installations/1/access_tokens",
"repositories_url": "https://HOSTNAME/installation/repositories",
"html_url": "https://github.com/organizations/github/settings/installations/1",
"app_id": 1,
"target_id": 1,
"target_type": "Organization",
"permissions": {
"checks": "write",
"metadata": "read",
"contents": "read"
},
"events": [
"push",
"pull_request"
],
"single_file_name": "config.yaml",
"has_multiple_single_files": true,
"single_file_paths": [
"config.yml",
".github/issue_TEMPLATE.md"
],
"repository_selection": "selected",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
Delete an installation for the authenticated app
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.
Tokens de acesso refinados para "Delete an installation for the authenticated app"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Delete an installation for the authenticated app"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
installation_id integer ObrigatórioThe unique identifier of the installation. |
Códigos de status de resposta HTTP para "Delete an installation for the authenticated app"
Código de status | Descrição |
---|---|
204 | No Content |
404 | Resource not found |
Exemplos de código para "Delete an installation for the authenticated app"
Exemplo de solicitação
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/app/installations/1
Response
Status: 204
Create an installation access token for an app
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.
Optionally, you can use the repositories
or repository_ids
body parameters to specify individual repositories that the installation access token can access. If you don't use repositories
or repository_ids
to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.
Optionally, use the permissions
body parameter to specify the permissions that the installation access token should have. If permissions
is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.
When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.
You must use a JWT to access this endpoint.
Tokens de acesso refinados para "Create an installation access token for an app"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Create an installation access token for an app"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
installation_id integer ObrigatórioThe unique identifier of the installation. |
Nome, Tipo, Descrição | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
repositories array of strings List of repository names that the token should have access to | |||||||||||||||||||||||||||||||||||||||||||||||||
repository_ids array of integers List of repository IDs that the token should have access to | |||||||||||||||||||||||||||||||||||||||||||||||||
permissions object The permissions granted to the user access token. | |||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nome, Tipo, Descrição |
---|
actions string The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Pode ser um dos: |
administration string The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Pode ser um dos: |
checks string The level of permission to grant the access token for checks on code. Pode ser um dos: |
codespaces string The level of permission to grant the access token to create, edit, delete, and list Codespaces. Pode ser um dos: |
contents string The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Pode ser um dos: |
dependabot_secrets string The leve of permission to grant the access token to manage Dependabot secrets. Pode ser um dos: |
deployments string The level of permission to grant the access token for deployments and deployment statuses. Pode ser um dos: |
environments string The level of permission to grant the access token for managing repository environments. Pode ser um dos: |
issues string The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Pode ser um dos: |
metadata string The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Pode ser um dos: |
packages string The level of permission to grant the access token for packages published to GitHub Packages. Pode ser um dos: |
pages string The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Pode ser um dos: |
pull_requests string The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Pode ser um dos: |
repository_custom_properties string The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. Pode ser um dos: |
repository_hooks string The level of permission to grant the access token to manage the post-receive hooks for a repository. Pode ser um dos: |
repository_projects string The level of permission to grant the access token to manage repository projects, columns, and cards. Pode ser um dos: |
secret_scanning_alerts string The level of permission to grant the access token to view and manage secret scanning alerts. Pode ser um dos: |
secrets string The level of permission to grant the access token to manage repository secrets. Pode ser um dos: |
security_events string The level of permission to grant the access token to view and manage security events like code scanning alerts. Pode ser um dos: |
single_file string The level of permission to grant the access token to manage just a single file. Pode ser um dos: |
statuses string The level of permission to grant the access token for commit statuses. Pode ser um dos: |
vulnerability_alerts string The level of permission to grant the access token to manage Dependabot alerts. Pode ser um dos: |
workflows string The level of permission to grant the access token to update GitHub Actions workflow files. Valor: |
members string The level of permission to grant the access token for organization teams and members. Pode ser um dos: |
organization_administration string The level of permission to grant the access token to manage access to an organization. Pode ser um dos: |
organization_custom_roles string The level of permission to grant the access token for custom repository roles management. Pode ser um dos: |
organization_custom_org_roles string The level of permission to grant the access token for custom organization roles management. Pode ser um dos: |
organization_custom_properties string The level of permission to grant the access token for custom property management. Pode ser um dos: |
organization_copilot_seat_management string The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. Valor: |
organization_announcement_banners string The level of permission to grant the access token to view and manage announcement banners for an organization. Pode ser um dos: |
organization_events string The level of permission to grant the access token to view events triggered by an activity in an organization. Valor: |
organization_hooks string The level of permission to grant the access token to manage the post-receive hooks for an organization. Pode ser um dos: |
organization_personal_access_tokens string The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. Pode ser um dos: |
organization_personal_access_token_requests string The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. Pode ser um dos: |
organization_plan string The level of permission to grant the access token for viewing an organization's plan. Valor: |
organization_projects string The level of permission to grant the access token to manage organization projects and projects public preview (where available). Pode ser um dos: |
organization_packages string The level of permission to grant the access token for organization packages published to GitHub Packages. Pode ser um dos: |
organization_secrets string The level of permission to grant the access token to manage organization secrets. Pode ser um dos: |
organization_self_hosted_runners string The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Pode ser um dos: |
organization_user_blocking string The level of permission to grant the access token to view and manage users blocked by the organization. Pode ser um dos: |
team_discussions string The level of permission to grant the access token to manage team discussions and related comments. Pode ser um dos: |
email_addresses string The level of permission to grant the access token to manage the email addresses belonging to a user. Pode ser um dos: |
followers string The level of permission to grant the access token to manage the followers belonging to a user. Pode ser um dos: |
git_ssh_keys string The level of permission to grant the access token to manage git SSH keys. Pode ser um dos: |
gpg_keys string The level of permission to grant the access token to view and manage GPG keys belonging to a user. Pode ser um dos: |
interaction_limits string The level of permission to grant the access token to view and manage interaction limits on a repository. Pode ser um dos: |
profile string The level of permission to grant the access token to manage the profile settings belonging to a user. Valor: |
starring string The level of permission to grant the access token to list and manage repositories a user is starring. Pode ser um dos: |
Códigos de status de resposta HTTP para "Create an installation access token for an app"
Código de status | Descrição |
---|---|
201 | Created |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Create an installation access token for an app"
Exemplo de solicitação
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/app/installations/1/access_tokens \
-d '{"repositories":["Hello-World"],"permissions":{"issues":"write","contents":"read"}}'
Response
Status: 201
{
"token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a",
"expires_at": "2016-07-11T22:14:10Z",
"permissions": {
"issues": "write",
"contents": "read"
},
"repository_selection": "selected",
"repositories": [
{
"id": 1296269,
"node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
"name": "Hello-World",
"full_name": "octocat/Hello-World",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"private": false,
"html_url": "https://github.com/octocat/Hello-World",
"description": "This your first repo!",
"fork": false,
"url": "https://HOSTNAME/repos/octocat/Hello-World",
"archive_url": "https://HOSTNAME/repos/octocat/Hello-World/{archive_format}{/ref}",
"assignees_url": "https://HOSTNAME/repos/octocat/Hello-World/assignees{/user}",
"blobs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/blobs{/sha}",
"branches_url": "https://HOSTNAME/repos/octocat/Hello-World/branches{/branch}",
"collaborators_url": "https://HOSTNAME/repos/octocat/Hello-World/collaborators{/collaborator}",
"comments_url": "https://HOSTNAME/repos/octocat/Hello-World/comments{/number}",
"commits_url": "https://HOSTNAME/repos/octocat/Hello-World/commits{/sha}",
"compare_url": "https://HOSTNAME/repos/octocat/Hello-World/compare/{base}...{head}",
"contents_url": "https://HOSTNAME/repos/octocat/Hello-World/contents/{+path}",
"contributors_url": "https://HOSTNAME/repos/octocat/Hello-World/contributors",
"deployments_url": "https://HOSTNAME/repos/octocat/Hello-World/deployments",
"downloads_url": "https://HOSTNAME/repos/octocat/Hello-World/downloads",
"events_url": "https://HOSTNAME/repos/octocat/Hello-World/events",
"forks_url": "https://HOSTNAME/repos/octocat/Hello-World/forks",
"git_commits_url": "https://HOSTNAME/repos/octocat/Hello-World/git/commits{/sha}",
"git_refs_url": "https://HOSTNAME/repos/octocat/Hello-World/git/refs{/sha}",
"git_tags_url": "https://HOSTNAME/repos/octocat/Hello-World/git/tags{/sha}",
"git_url": "git:github.com/octocat/Hello-World.git",
"issue_comment_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/comments{/number}",
"issue_events_url": "https://HOSTNAME/repos/octocat/Hello-World/issues/events{/number}",
"issues_url": "https://HOSTNAME/repos/octocat/Hello-World/issues{/number}",
"keys_url": "https://HOSTNAME/repos/octocat/Hello-World/keys{/key_id}",
"labels_url": "https://HOSTNAME/repos/octocat/Hello-World/labels{/name}",
"languages_url": "https://HOSTNAME/repos/octocat/Hello-World/languages",
"merges_url": "https://HOSTNAME/repos/octocat/Hello-World/merges",
"milestones_url": "https://HOSTNAME/repos/octocat/Hello-World/milestones{/number}",
"notifications_url": "https://HOSTNAME/repos/octocat/Hello-World/notifications{?since,all,participating}",
"pulls_url": "https://HOSTNAME/repos/octocat/Hello-World/pulls{/number}",
"releases_url": "https://HOSTNAME/repos/octocat/Hello-World/releases{/id}",
"ssh_url": "git@github.com:octocat/Hello-World.git",
"stargazers_url": "https://HOSTNAME/repos/octocat/Hello-World/stargazers",
"statuses_url": "https://HOSTNAME/repos/octocat/Hello-World/statuses/{sha}",
"subscribers_url": "https://HOSTNAME/repos/octocat/Hello-World/subscribers",
"subscription_url": "https://HOSTNAME/repos/octocat/Hello-World/subscription",
"tags_url": "https://HOSTNAME/repos/octocat/Hello-World/tags",
"teams_url": "https://HOSTNAME/repos/octocat/Hello-World/teams",
"trees_url": "https://HOSTNAME/repos/octocat/Hello-World/git/trees{/sha}",
"clone_url": "https://github.com/octocat/Hello-World.git",
"mirror_url": "git:git.example.com/octocat/Hello-World",
"hooks_url": "https://HOSTNAME/repos/octocat/Hello-World/hooks",
"svn_url": "https://svn.github.com/octocat/Hello-World",
"homepage": "https://github.com",
"language": null,
"forks_count": 9,
"stargazers_count": 80,
"watchers_count": 80,
"size": 108,
"default_branch": "master",
"open_issues_count": 0,
"is_template": true,
"topics": [
"octocat",
"atom",
"electron",
"api"
],
"has_issues": true,
"has_projects": true,
"has_wiki": true,
"has_pages": false,
"has_downloads": true,
"archived": false,
"disabled": false,
"visibility": "public",
"pushed_at": "2011-01-26T19:06:43Z",
"created_at": "2011-01-26T19:01:12Z",
"updated_at": "2011-01-26T19:14:43Z",
"permissions": {
"admin": false,
"push": false,
"pull": true
},
"allow_rebase_merge": true,
"template_repository": null,
"temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
"allow_squash_merge": true,
"allow_auto_merge": false,
"delete_branch_on_merge": true,
"allow_merge_commit": true,
"subscribers_count": 42,
"network_count": 0,
"license": {
"key": "mit",
"name": "MIT License",
"url": "https://HOSTNAME/licenses/mit",
"spdx_id": "MIT",
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"forks": 1,
"open_issues": 1,
"watchers": 1
}
]
}
Suspend an app installation
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.
Tokens de acesso refinados para "Suspend an app installation"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Suspend an app installation"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
installation_id integer ObrigatórioThe unique identifier of the installation. |
Códigos de status de resposta HTTP para "Suspend an app installation"
Código de status | Descrição |
---|---|
204 | No Content |
404 | Resource not found |
Exemplos de código para "Suspend an app installation"
Exemplo de solicitação
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/app/installations/1/suspended
Response
Status: 204
Unsuspend an app installation
Removes a GitHub App installation suspension.
You must use a JWT to access this endpoint.
Tokens de acesso refinados para "Unsuspend an app installation"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Unsuspend an app installation"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
installation_id integer ObrigatórioThe unique identifier of the installation. |
Códigos de status de resposta HTTP para "Unsuspend an app installation"
Código de status | Descrição |
---|---|
204 | No Content |
404 | Resource not found |
Exemplos de código para "Unsuspend an app installation"
Exemplo de solicitação
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/app/installations/1/suspended
Response
Status: 204
Create a scoped access token
Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token.
Invalid tokens will return 404 NOT FOUND
.
Autenticação básica para “Create a scoped access token”
É necessário usar autenticação básica para usar este ponto de extremidade. Use o client_id
do aplicativo como o nome de usuário e o client_secret
como a senha.
Parâmetros para "Create a scoped access token"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
client_id string ObrigatórioThe client ID of the GitHub app. |
Nome, Tipo, Descrição | |||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
access_token string ObrigatórioThe access token used to authenticate to the GitHub API. | |||||||||||||||||||||||||||||||||||||||||||||||||
target string The name of the user or organization to scope the user access token to. Required unless | |||||||||||||||||||||||||||||||||||||||||||||||||
target_id integer The ID of the user or organization to scope the user access token to. Required unless | |||||||||||||||||||||||||||||||||||||||||||||||||
repositories array of strings The list of repository names to scope the user access token to. | |||||||||||||||||||||||||||||||||||||||||||||||||
repository_ids array of integers The list of repository IDs to scope the user access token to. | |||||||||||||||||||||||||||||||||||||||||||||||||
permissions object The permissions granted to the user access token. | |||||||||||||||||||||||||||||||||||||||||||||||||
Properties of |
Nome, Tipo, Descrição |
---|
actions string The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Pode ser um dos: |
administration string The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Pode ser um dos: |
checks string The level of permission to grant the access token for checks on code. Pode ser um dos: |
codespaces string The level of permission to grant the access token to create, edit, delete, and list Codespaces. Pode ser um dos: |
contents string The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Pode ser um dos: |
dependabot_secrets string The leve of permission to grant the access token to manage Dependabot secrets. Pode ser um dos: |
deployments string The level of permission to grant the access token for deployments and deployment statuses. Pode ser um dos: |
environments string The level of permission to grant the access token for managing repository environments. Pode ser um dos: |
issues string The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Pode ser um dos: |
metadata string The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Pode ser um dos: |
packages string The level of permission to grant the access token for packages published to GitHub Packages. Pode ser um dos: |
pages string The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Pode ser um dos: |
pull_requests string The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Pode ser um dos: |
repository_custom_properties string The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. Pode ser um dos: |
repository_hooks string The level of permission to grant the access token to manage the post-receive hooks for a repository. Pode ser um dos: |
repository_projects string The level of permission to grant the access token to manage repository projects, columns, and cards. Pode ser um dos: |
secret_scanning_alerts string The level of permission to grant the access token to view and manage secret scanning alerts. Pode ser um dos: |
secrets string The level of permission to grant the access token to manage repository secrets. Pode ser um dos: |
security_events string The level of permission to grant the access token to view and manage security events like code scanning alerts. Pode ser um dos: |
single_file string The level of permission to grant the access token to manage just a single file. Pode ser um dos: |
statuses string The level of permission to grant the access token for commit statuses. Pode ser um dos: |
vulnerability_alerts string The level of permission to grant the access token to manage Dependabot alerts. Pode ser um dos: |
workflows string The level of permission to grant the access token to update GitHub Actions workflow files. Valor: |
members string The level of permission to grant the access token for organization teams and members. Pode ser um dos: |
organization_administration string The level of permission to grant the access token to manage access to an organization. Pode ser um dos: |
organization_custom_roles string The level of permission to grant the access token for custom repository roles management. Pode ser um dos: |
organization_custom_org_roles string The level of permission to grant the access token for custom organization roles management. Pode ser um dos: |
organization_custom_properties string The level of permission to grant the access token for custom property management. Pode ser um dos: |
organization_copilot_seat_management string The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. Valor: |
organization_announcement_banners string The level of permission to grant the access token to view and manage announcement banners for an organization. Pode ser um dos: |
organization_events string The level of permission to grant the access token to view events triggered by an activity in an organization. Valor: |
organization_hooks string The level of permission to grant the access token to manage the post-receive hooks for an organization. Pode ser um dos: |
organization_personal_access_tokens string The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. Pode ser um dos: |
organization_personal_access_token_requests string The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. Pode ser um dos: |
organization_plan string The level of permission to grant the access token for viewing an organization's plan. Valor: |
organization_projects string The level of permission to grant the access token to manage organization projects and projects public preview (where available). Pode ser um dos: |
organization_packages string The level of permission to grant the access token for organization packages published to GitHub Packages. Pode ser um dos: |
organization_secrets string The level of permission to grant the access token to manage organization secrets. Pode ser um dos: |
organization_self_hosted_runners string The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Pode ser um dos: |
organization_user_blocking string The level of permission to grant the access token to view and manage users blocked by the organization. Pode ser um dos: |
team_discussions string The level of permission to grant the access token to manage team discussions and related comments. Pode ser um dos: |
email_addresses string The level of permission to grant the access token to manage the email addresses belonging to a user. Pode ser um dos: |
followers string The level of permission to grant the access token to manage the followers belonging to a user. Pode ser um dos: |
git_ssh_keys string The level of permission to grant the access token to manage git SSH keys. Pode ser um dos: |
gpg_keys string The level of permission to grant the access token to view and manage GPG keys belonging to a user. Pode ser um dos: |
interaction_limits string The level of permission to grant the access token to view and manage interaction limits on a repository. Pode ser um dos: |
profile string The level of permission to grant the access token to manage the profile settings belonging to a user. Valor: |
starring string The level of permission to grant the access token to list and manage repositories a user is starring. Pode ser um dos: |
Códigos de status de resposta HTTP para "Create a scoped access token"
Código de status | Descrição |
---|---|
200 | OK |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Create a scoped access token"
Exemplo de solicitação
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-u "<YOUR_CLIENT_ID>:<YOUR_CLIENT_SECRET>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/applications/Iv1.8a61f9b3a7aba766/token/scoped \
-d '{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a","target":"octocat","permissions":{"metadata":"read","issues":"write","contents":"read"}}'
Response
Status: 200
{
"id": 1,
"url": "https://HOSTNAME/authorizations/1",
"scopes": [],
"token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a",
"token_last_eight": "Ae178B4a",
"hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
"app": {
"url": "http://my-github-app.com",
"name": "my github app",
"client_id": "Iv1.8a61f9b3a7aba766"
},
"note": "optional note",
"note_url": "http://optional/note/url",
"updated_at": "2011-09-06T20:39:23Z",
"created_at": "2011-09-06T17:26:27Z",
"fingerprint": "jklmnop12345678",
"expires_at": "2011-09-08T17:26:27Z",
"user": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"installation": {
"permissions": {
"metadata": "read",
"issues": "write",
"contents": "read"
},
"repository_selection": "selected",
"single_file_name": ".github/workflow.yml",
"repositories_url": "https://HOSTNAME/user/repos",
"account": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"has_multiple_single_files": false,
"single_file_paths": []
}
}
Get an app
Note
The :app_slug
is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug
).
Tokens de acesso refinados para "Get an app"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinaado não requer permissões.
Esse ponto de extremidade pode ser usado sem autenticação se apenas recursos públicos forem solicitados.
Parâmetros para "Get an app"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
app_slug string Obrigatório |
Códigos de status de resposta HTTP para "Get an app"
Código de status | Descrição |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "Get an app"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/apps/APP_SLUG
Response
Status: 200
{
"id": 1,
"slug": "octoapp",
"client_id": "Iv1.ab1112223334445c",
"node_id": "MDExOkludGVncmF0aW9uMQ==",
"owner": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"name": "Octocat App",
"description": "",
"external_url": "https://example.com",
"html_url": "https://github.com/apps/octoapp",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"permissions": {
"metadata": "read",
"contents": "read",
"issues": "write",
"single_file": "write"
},
"events": [
"push",
"pull_request"
]
}
Get an organization installation for the authenticated app
Enables an authenticated GitHub App to find the organization's installation information.
You must use a JWT to access this endpoint.
Tokens de acesso refinados para "Get an organization installation for the authenticated app"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Get an organization installation for the authenticated app"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Códigos de status de resposta HTTP para "Get an organization installation for the authenticated app"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get an organization installation for the authenticated app"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/installation
Response
Status: 200
{
"id": 1,
"account": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"avatar_url": "https://github.com/images/error/hubot_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/orgs/github",
"html_url": "https://github.com/github",
"followers_url": "https://HOSTNAME/users/github/followers",
"following_url": "https://HOSTNAME/users/github/following{/other_user}",
"gists_url": "https://HOSTNAME/users/github/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/github/subscriptions",
"organizations_url": "https://HOSTNAME/users/github/orgs",
"repos_url": "https://HOSTNAME/orgs/github/repos",
"events_url": "https://HOSTNAME/orgs/github/events",
"received_events_url": "https://HOSTNAME/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"repository_selection": "all",
"access_tokens_url": "https://HOSTNAME/app/installations/1/access_tokens",
"repositories_url": "https://HOSTNAME/installation/repositories",
"html_url": "https://github.com/organizations/github/settings/installations/1",
"app_id": 1,
"client_id": "Iv1.ab1112223334445c",
"target_id": 1,
"target_type": "Organization",
"permissions": {
"checks": "write",
"metadata": "read",
"contents": "read"
},
"events": [
"push",
"pull_request"
],
"created_at": "2018-02-09T20:51:14Z",
"updated_at": "2018-02-09T20:51:14Z",
"single_file_name": "config.yml",
"has_multiple_single_files": true,
"single_file_paths": [
"config.yml",
".github/issue_TEMPLATE.md"
],
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
Get a repository installation for the authenticated app
Enables 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.
Tokens de acesso refinados para "Get a repository installation for the authenticated app"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Get a repository installation for the authenticated app"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
Códigos de status de resposta HTTP para "Get a repository installation for the authenticated app"
Código de status | Descrição |
---|---|
200 | OK |
301 | Moved permanently |
404 | Resource not found |
Exemplos de código para "Get a repository installation for the authenticated app"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/installation
Response
Status: 200
{
"id": 1,
"account": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"avatar_url": "https://github.com/images/error/hubot_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/orgs/github",
"html_url": "https://github.com/github",
"followers_url": "https://HOSTNAME/users/github/followers",
"following_url": "https://HOSTNAME/users/github/following{/other_user}",
"gists_url": "https://HOSTNAME/users/github/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/github/subscriptions",
"organizations_url": "https://HOSTNAME/users/github/orgs",
"repos_url": "https://HOSTNAME/orgs/github/repos",
"events_url": "https://HOSTNAME/orgs/github/events",
"received_events_url": "https://HOSTNAME/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"repository_selection": "all",
"access_tokens_url": "https://HOSTNAME/app/installations/1/access_tokens",
"repositories_url": "https://HOSTNAME/installation/repositories",
"html_url": "https://github.com/organizations/github/settings/installations/1",
"app_id": 1,
"client_id": "Iv1.ab1112223334445c",
"target_id": 1,
"target_type": "Organization",
"permissions": {
"checks": "write",
"metadata": "read",
"contents": "read"
},
"events": [
"push",
"pull_request"
],
"created_at": "2018-02-09T20:51:14Z",
"updated_at": "2018-02-09T20:51:14Z",
"single_file_name": "config.yml",
"has_multiple_single_files": true,
"single_file_paths": [
"config.yml",
".github/issue_TEMPLATE.md"
],
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
Get a user installation for the authenticated app
Enables an authenticated GitHub App to find the user’s installation information.
You must use a JWT to access this endpoint.
Tokens de acesso refinados para "Get a user installation for the authenticated app"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Get a user installation for the authenticated app"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
username string ObrigatórioThe handle for the GitHub user account. |
Códigos de status de resposta HTTP para "Get a user installation for the authenticated app"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "Get a user installation for the authenticated app"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/users/USERNAME/installation
Response
Status: 200
{
"id": 1,
"account": {
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"avatar_url": "https://github.com/images/error/hubot_happy.gif",
"gravatar_id": "",
"url": "https://HOSTNAME/orgs/github",
"html_url": "https://github.com/github",
"followers_url": "https://HOSTNAME/users/github/followers",
"following_url": "https://HOSTNAME/users/github/following{/other_user}",
"gists_url": "https://HOSTNAME/users/github/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/github/subscriptions",
"organizations_url": "https://HOSTNAME/users/github/orgs",
"repos_url": "https://HOSTNAME/orgs/github/repos",
"events_url": "https://HOSTNAME/orgs/github/events",
"received_events_url": "https://HOSTNAME/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"repository_selection": "all",
"access_tokens_url": "https://HOSTNAME/app/installations/1/access_tokens",
"repositories_url": "https://HOSTNAME/installation/repositories",
"html_url": "https://github.com/organizations/github/settings/installations/1",
"app_id": 1,
"client_id": "Iv1.ab1112223334445c",
"target_id": 1,
"target_type": "Organization",
"permissions": {
"checks": "write",
"metadata": "read",
"contents": "read"
},
"events": [
"push",
"pull_request"
],
"created_at": "2018-02-09T20:51:14Z",
"updated_at": "2018-02-09T20:51:14Z",
"single_file_name": "config.yml",
"has_multiple_single_files": true,
"single_file_paths": [
"config.yml",
".github/issue_TEMPLATE.md"
],
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}