How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Installations API

The Installations API from GitHub — 13 operation(s) for installations.

GitHub Installations API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Installations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 16 operations across 13 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against 2 base URLs: {protocol}://{hostname}/api/v3, {protocol}://{hostname}.

16 operations 13 paths 15 schemas 4 DELETE9 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Installations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 16

Across 13 paths, the API surfaces 16 operations — 4 DELETE, 9 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Installations 16
GET
/app/installation-requests
GitHub List Installation Requests for the Authenticated App
listInstallationRequestsForTheAuthenticatedApp 2 params → 200304401
GET
/app/installations
GitHub List Installations for the Authenticated App
listInstallationsForTheAuthenticatedApp 4 params → 200
GET
/app/installations/{installation_id}
GitHub Get an Installation for the Authenticated App
getAnInstallationForTheAuthenticatedApp 1 param → 200404
DELETE
/app/installations/{installation_id}
GitHub Delete an Installation for the Authenticated App
deleteAnInstallationForTheAuthenticatedApp 1 param → 204404
POST
/app/installations/{installation_id}/access_tokens
GitHub Create an Installation Access Token for an App
createAnInstallationAccessTokenForAnApp 1 param body → 201401403404422
PUT
/app/installations/{installation_id}/suspended
GitHub Suspend an App Installation
suspendAnAppInstallation 1 param → 204404
DELETE
/app/installations/{installation_id}/suspended
GitHub Unsuspend an App Installation
unsuspendAnAppInstallation 1 param → 204404
GET
/installation/repositories
GitHub List Repositories Accessible to the App Installation
listRepositoriesAccessibleToTheAppInstallation 2 params → 200304401403
DELETE
/installation/token
GitHub Revoke an Installation Access Token
revokeAnInstallationAccessToken → 204
GET
/orgs/{org}/installation
GitHub Get an Organization Installation for the Authenticated App
getAnOrganizationInstallationForTheAuthenticatedApp 1 param → 200
GET
/orgs/{org}/installations
GitHub List App Installations for an Organization
listAppInstallationsForAnOrganization 3 params → 200
GET
/repos/{owner}/{repo}/installation
GitHub Get Repository Installation for the Authenticated App
getrepositoryInstallationForTheAuthenticatedApp 2 params → 200301404
GET
/user/installations
GitHub List App Installations Accessible to the User Access Token
listAppInstallationsAccessibleToTheUserAccessToken 2 params → 200304401403
PUT
/user/installations/{installation_id}/repositories/{repository_id}
GitHub Add Repository to an App Installation
addrepositoryToAnAppInstallation 2 params → 204304403404
DELETE
/user/installations/{installation_id}/repositories/{repository_id}
GitHub Remove Repository from an App Installation
removerepositoryFromAnAppInstallation 2 params → 204304403404
GET
/users/{username}/installation
GitHub Get User Installation for the Authenticated App
getuserInstallationForTheAuthenticatedApp 1 param → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), app-permissions (45 properties), nullable-simple-user_2 (21 properties), nullable-simple-user (21 properties). Each schema is shown below with its type and property counts.

installation
object
Installation
20 properties 17 required
installation-token
object
Authentication token for a GitHub App installed on a user or org.
8 properties 2 required
simple-user
object
A GitHub user.
21 properties 18 required
repository
object
A repository on GitHub.
95 properties 73 required
validation-error
object
Validation Error
3 properties 2 required
basic-error
object
Basic Error
4 properties
integration-installation-request
object
Request to install an integration on a target
5 properties 4 required
enterprise
object
An enterprise on GitHub.
10 properties 8 required
app-permissions
object
The permissions granted to the user access token.
45 properties
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
nullable-license-simple
objectnull
License Simple
6 properties 5 required
simple-user_2
object
GitHub user.
21 properties 18 required
installation_2
object
Installation
20 properties 17 required
nullable-simple-user_2
object
GitHub user.
21 properties 18 required
enterprise_2
object
An enterprise on GitHub.
10 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-installations-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Installations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.