{ "opencollection": "1.0.0", "info": { "name": "GitHub Application API", "version": "1.1.4" }, "items": [ { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "GitHub Get the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app" }, "docs": "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](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-g" }, { "info": { "name": "GitHub Creategithub App Frommanifest", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/app-manifests/:code/conversions", "params": [ { "name": "code", "value": "example_value", "type": "path" } ] }, "docs": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/creating-github-apps-from-a-manifest/). 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`." }, { "info": { "name": "GitHub Getwebhook Configuration for an App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/hook/config" }, "docs": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Updatewebhook Configuration for an App", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/app/hook/config", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub List Deliveries for an App Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/hook/deliveries", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "cursor", "value": "", "type": "query", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors." }, { "name": "redelivery", "value": "true", "type": "query" } ] }, "docs": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Getdelivery for an App Webhook", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/hook/deliveries/:delivery_id", "params": [ { "name": "delivery_id", "value": "", "type": "path" } ] }, "docs": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Redeliverdelivery for an App Webhook", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/app/hook/deliveries/:delivery_id/attempts", "params": [ { "name": "delivery_id", "value": "", "type": "path" } ] }, "docs": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub List Installation Requests for the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/installation-requests", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" } ] }, "docs": "Lists all the pending installation requests for the authenticated GitHub App." }, { "info": { "name": "GitHub List Installations for the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/installations", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "since", "value": "", "type": "query", "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, { "name": "outdated", "value": "2026-04-17T12:00:00Z", "type": "query" } ] }, "docs": "The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Get an Installation for the Authenticated App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/app/installations/:installation_id", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." } ] }, "docs": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Delete an Installation for the Authenticated App", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/app/installations/:installation_id", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." } ] }, "docs": "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](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Suspend an App Installation", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/app/installations/:installation_id/suspended", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." } ] }, "docs": "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.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Unsuspend an App Installation", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/app/installations/:installation_id/suspended", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." } ] }, "docs": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint." }, { "info": { "name": "GitHub Delete an App Authorization", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/applications/:client_id/grant", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the GitHub app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeletin" }, { "info": { "name": "GitHub Delete an App Token", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/applications/:client_id/token", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the GitHub app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password." }, { "info": { "name": "GitHub Get an App", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/apps/:app_slug", "params": [ { "name": "app_slug", "value": "", "type": "path" } ] }, "docs": "**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`)." } ] }, { "info": { "name": "Access", "type": "folder" }, "items": [ { "info": { "name": "GitHub Create an Installation Access Token for an App", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/app/installations/:installation_id/access_tokens", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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. \n\nOptionally, you can use the `repositories` or " }, { "info": { "name": "GitHub Createscoped Access Token", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/applications/:client_id/token/scoped", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the GitHub app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.\n\nYou must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication)\nwhen accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App\nas t" }, { "info": { "name": "GitHub Get Apps with Access to the Protected Branch", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/apps", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ] }, "docs": "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](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are in" }, { "info": { "name": "GitHub Add App Access Restrictions", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/apps", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are install" }, { "info": { "name": "GitHub Set App Access Restrictions", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/apps", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps th" }, { "info": { "name": "GitHub Remove App Access Restrictions", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/branches/:branch/protection/restrictions/apps", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "branch", "value": "", "type": "path", "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installe" } ] }, { "info": { "name": "Grants", "type": "folder" }, "items": [ { "info": { "name": "GitHub List Your Grants", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/applications/grants", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "page", "value": "", "type": "query", "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"" }, { "name": "client_id", "value": "12345678", "type": "query", "description": "The client ID of your GitHub app." } ] }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.gith" } ] }, { "info": { "name": "Get", "type": "folder" }, "items": [ { "info": { "name": "GitHub Getsingle Grant", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/applications/grants/:grant_id", "params": [ { "name": "grant_id", "value": "", "type": "path", "description": "The unique identifier of the grant." } ] }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://" }, { "info": { "name": "GitHub Get the Review History Forworkflow Run", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}/api/v3/repos/:owner/:repo/actions/runs/:run_id/approvals", "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "run_id", "value": "", "type": "path", "description": "The unique identifier of the workflow run." } ] }, "docs": "Anyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository." } ] }, { "info": { "name": "Delete", "type": "folder" }, "items": [ { "info": { "name": "GitHub Deletegrant", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}/api/v3/applications/grants/:grant_id", "params": [ { "name": "grant_id", "value": "", "type": "path", "description": "The unique identifier of the grant." } ] }, "docs": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.gith" } ] }, { "info": { "name": "Checks", "type": "folder" }, "items": [ { "info": { "name": "GitHub Checktoken", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/api/v3/applications/:client_id/token", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the GitHub app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is it" } ] }, { "info": { "name": "Reset", "type": "folder" }, "items": [ { "info": { "name": "GitHub Reset Token", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}/api/v3/applications/:client_id/token", "params": [ { "name": "client_id", "value": "", "type": "path", "description": "The client ID of the GitHub app." } ], "body": { "type": "json", "data": "{}" } }, "docs": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the usernam" } ] } ], "bundled": true }