# Pontos de extremidade da API REST para {% data variables.product.prodname\_github\_app %} instalações Use a API REST para obter informações sobre GitHub App instalações e executar ações nessas instalações. ## Sobre GitHub App instalações Uma GitHub App instalação refere-se à instalação da aplicação em uma conta empresarial, de organização ou de usuário. Para obter informações sobre como se autenticar como uma instalação e limitar o acesso a repositórios específicos, confira [Como autenticar como uma instalação de Aplicativo GitHub](/pt/enterprise-cloud@latest/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation). Para listar todas as GitHub App instalações de uma organização, consulte [Pontos de extremidade de API REST para organizações](/pt/enterprise-cloud@latest/rest/orgs/orgs#list-app-installations-for-an-organization). > \[!NOTE] > Most endpoints use `Authorization: Bearer ` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2026-03-10`. Curl examples below omit these standard headers for brevity. ## List repositories accessible to the app installation ``` GET /installation/repositories ``` List repositories that an app installation can access. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`page`** (integer) The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1` ### HTTP response status codes * **200** - OK * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ https://api.github.com/installation/repositories ``` **Response schema (Status: 200):** * `total_count`: required, integer * `repositories`: required, array of object * `repository_selection`: string ## Revoke an installation access token ``` DELETE /installation/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. ### HTTP response status codes * **204** - No Content ### Code examples #### Example **Request:** ```curl curl -L \ -X DELETE \ https://api.github.com/installation/token ``` **Response schema (Status: 204):** ## List app installations accessible to the user access token ``` GET /user/installations ``` 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. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`page`** (integer) The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1` ### HTTP response status codes * **200** - You can find the permissions for the installation under the permissions key. * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ https://api.github.com/user/installations ``` **Response schema (Status: 200):** * `total_count`: required, integer * `installations`: required, array of `Installation`: * `id`: required, integer * `account`: required, any of: * **Simple User** * `name`: string or null * `email`: string or null * `login`: required, string * `id`: required, integer, format: int64 * `node_id`: required, string * `avatar_url`: required, string, format: uri * `gravatar_id`: required, string or null * `url`: required, string, format: uri * `html_url`: required, string, format: uri * `followers_url`: required, string, format: uri * `following_url`: required, string * `gists_url`: required, string * `starred_url`: required, string * `subscriptions_url`: required, string, format: uri * `organizations_url`: required, string, format: uri * `repos_url`: required, string, format: uri * `events_url`: required, string * `received_events_url`: required, string, format: uri * `type`: required, string * `site_admin`: required, boolean * `starred_at`: string * `user_view_type`: string * **Enterprise** * `description`: string or null * `html_url`: required, string, format: uri * `website_url`: string or null, format: uri * `id`: required, integer * `node_id`: required, string * `name`: required, string * `slug`: required, string * `created_at`: required, string or null, format: date-time * `updated_at`: required, string or null, format: date-time * `avatar_url`: required, string, format: uri * `repository_selection`: required, string, enum: `all`, `selected` * `access_tokens_url`: required, string, format: uri * `repositories_url`: required, string, format: uri * `html_url`: required, string, format: uri * `app_id`: required, integer * `client_id`: string * `target_id`: required, integer * `target_type`: required, string * `permissions`: required, `App Permissions`: * `actions`: string, enum: `read`, `write` * `administration`: string, enum: `read`, `write` * `artifact_metadata`: string, enum: `read`, `write` * `attestations`: string, enum: `read`, `write` * `checks`: string, enum: `read`, `write` * `code_quality`: string, enum: `read`, `write` * `codespaces`: string, enum: `read`, `write` * `contents`: string, enum: `read`, `write` * `dependabot_secrets`: string, enum: `read`, `write` * `deployments`: string, enum: `read`, `write` * `discussions`: string, enum: `read`, `write` * `environments`: string, enum: `read`, `write` * `issues`: string, enum: `read`, `write` * `merge_queues`: string, enum: `read`, `write` * `metadata`: string, enum: `read`, `write` * `packages`: string, enum: `read`, `write` * `pages`: string, enum: `read`, `write` * `pull_requests`: string, enum: `read`, `write` * `repository_custom_properties`: string, enum: `read`, `write` * `repository_hooks`: string, enum: `read`, `write` * `repository_projects`: string, enum: `read`, `write`, `admin` * `secret_scanning_alerts`: string, enum: `read`, `write` * `secrets`: string, enum: `read`, `write` * `security_events`: string, enum: `read`, `write` * `single_file`: string, enum: `read`, `write` * `statuses`: string, enum: `read`, `write` * `vulnerability_alerts`: string, enum: `read`, `write` * `workflows`: string, enum: `write` * `custom_properties_for_organizations`: string, enum: `read`, `write` * `members`: string, enum: `read`, `write` * `organization_administration`: string, enum: `read`, `write` * `organization_custom_roles`: string, enum: `read`, `write` * `organization_custom_org_roles`: string, enum: `read`, `write` * `organization_custom_properties`: string, enum: `read`, `write`, `admin` * `organization_copilot_seat_management`: string, enum: `read`, `write` * `organization_copilot_agent_settings`: string, enum: `read`, `write` * `organization_announcement_banners`: string, enum: `read`, `write` * `organization_events`: string, enum: `read` * `organization_hooks`: string, enum: `read`, `write` * `organization_personal_access_tokens`: string, enum: `read`, `write` * `organization_personal_access_token_requests`: string, enum: `read`, `write` * `organization_plan`: string, enum: `read` * `organization_projects`: string, enum: `read`, `write`, `admin` * `organization_packages`: string, enum: `read`, `write` * `organization_secrets`: string, enum: `read`, `write` * `organization_self_hosted_runners`: string, enum: `read`, `write` * `organization_user_blocking`: string, enum: `read`, `write` * `email_addresses`: string, enum: `read`, `write` * `followers`: string, enum: `read`, `write` * `git_ssh_keys`: string, enum: `read`, `write` * `gpg_keys`: string, enum: `read`, `write` * `interaction_limits`: string, enum: `read`, `write` * `profile`: string, enum: `write` * `starring`: string, enum: `read`, `write` * `enterprise_administration`: string, enum: `read`, `write` * `enterprise_custom_properties_for_organizations`: string, enum: `read`, `write`, `admin` * `enterprise_organization_installations`: string, enum: `read`, `write` * `enterprise_organization_installation_repositories`: string, enum: `read`, `write` * `events`: required, array of string * `created_at`: required, string, format: date-time * `updated_at`: required, string, format: date-time * `single_file_name`: required, string or null * `has_multiple_single_files`: boolean * `single_file_paths`: array of string * `app_slug`: required, string * `suspended_by`: required, any of: * **null** * **Simple User** * `name`: string or null * `email`: string or null * `login`: required, string * `id`: required, integer, format: int64 * `node_id`: required, string * `avatar_url`: required, string, format: uri * `gravatar_id`: required, string or null * `url`: required, string, format: uri * `html_url`: required, string, format: uri * `followers_url`: required, string, format: uri * `following_url`: required, string * `gists_url`: required, string * `starred_url`: required, string * `subscriptions_url`: required, string, format: uri * `organizations_url`: required, string, format: uri * `repos_url`: required, string, format: uri * `events_url`: required, string * `received_events_url`: required, string, format: uri * `type`: required, string * `site_admin`: required, boolean * `starred_at`: string * `user_view_type`: string * `suspended_at`: required, string or null, format: date-time * `contact_email`: string or null ## List repositories accessible to the user access token ``` GET /user/installations/{installation_id}/repositories ``` 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. The access the user has to each repository is included in the hash under the permissions key. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`installation_id`** (integer) (required) The unique identifier of the installation. * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`page`** (integer) The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1` ### HTTP response status codes * **200** - The access the user has to each repository is included in the hash under the permissions key. * **304** - Not modified * **403** - Forbidden * **404** - Resource not found ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ https://api.github.com/user/installations/1/repositories ``` **Response schema (Status: 200):** * `total_count`: required, integer * `repository_selection`: string * `repositories`: required, array of object ## Add a repository to an app installation ``` PUT /user/installations/{installation_id}/repositories/{repository_id} ``` Add a single repository to an installation. The authenticated user must have admin access to the repository. This endpoint only works for PATs (classic) with the repo scope. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`installation_id`** (integer) (required) The unique identifier of the installation. * **`repository_id`** (integer) (required) The unique identifier of the repository. ### HTTP response status codes * **204** - No Content * **304** - Not modified * **403** - Forbidden * **404** - Resource not found ### Code examples #### Example **Request:** ```curl curl -L \ -X PUT \ https://api.github.com/user/installations/1/repositories/REPOSITORY_ID ``` **Response schema (Status: 204):** ## Remove a repository from an app installation ``` DELETE /user/installations/{installation_id}/repositories/{repository_id} ``` Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the repository\_selection of selected. This endpoint only works for PATs (classic) with the repo scope. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`installation_id`** (integer) (required) The unique identifier of the installation. * **`repository_id`** (integer) (required) The unique identifier of the repository. ### HTTP response status codes * **204** - No Content * **304** - Not modified * **403** - Forbidden * **404** - Resource not found * **422** - Returned when the application is installed on all repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. ### Code examples #### Example **Request:** ```curl curl -L \ -X DELETE \ https://api.github.com/user/installations/1/repositories/REPOSITORY_ID ``` **Response schema (Status: 204):**