{"@context": "https://schema.org", "@type": "WebAPI", "name": "GitHub v3 REST API API", "description": "GitHub's v3 REST API.", "provider": {"@type": "Organization", "name": "github.com"}, "documentation": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json"}
GitHub's v3 REST API.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.github.com https://github.com
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | GitHub API Root Get Hypermedia links to resources accessible in GitHub's REST API meta |
GET | /app | Get the authenticated app Returns the GitHub App associated with the authentication credentials used. To see h |
POST | /app-manifests/{code}/conversions | Create a GitHub App from a manifest Use this endpoint to complete the handshake necessary when implementing th |
GET | /app/hook/config | Get a webhook configuration for an app Returns the webhook configuration for a GitHub App. For more informatio |
PATCH | /app/hook/config | Update a webhook configuration for an app Updates the webhook configuration for a GitHub App. For more informa |
GET | /app/hook/deliveries | List deliveries for an app webhook Returns a list of webhook deliveries for the webhook configured for a GitHu |
GET | /app/hook/deliveries/{delivery_id} | Get a delivery for an app webhook Returns a delivery for the webhook configured for a GitHub App. You must us |
POST | /app/hook/deliveries/{delivery_id}/attempts | Redeliver a delivery for an app webhook Redeliver a delivery for the webhook configured for a GitHub App. You |
GET | /app/installations | List installations for the authenticated app You must use a [JWT](https://docs.github.com/apps/building-github |
GET | /app/installations/{installation_id} | Get an installation for the authenticated app Enables an authenticated GitHub App to find an installation's in |
DELETE | /app/installations/{installation_id} | Delete an installation for the authenticated app Uninstalls a GitHub App on a user, organization, or business |
POST | /app/installations/{installation_id}/access_tokens | Create an installation access token for an app Creates an installation access token that enables a GitHub App |
PUT | /app/installations/{installation_id}/suspended | Suspend an app installation Suspends a GitHub App on a user, organization, or business account, which blocks t |
DELETE | /app/installations/{installation_id}/suspended | Unsuspend an app installation Removes a GitHub App installation suspension. You must use a [JWT](https://docs |
DELETE | /applications/{client_id}/grant | Delete an app authorization OAuth application owners can revoke a grant for their OAuth application and a spec |
POST | /applications/{client_id}/token | Check a token OAuth applications can use a special API method for checking OAuth token validity without exceed |
PATCH | /applications/{client_id}/token | Reset a token OAuth applications can use this API method to reset a valid OAuth token without end-user involve |
DELETE | /applications/{client_id}/token | Delete an app token OAuth application owners can revoke a single token for an OAuth application. You must use |
POST | /applications/{client_id}/token/scoped | Create a scoped access token Use a non-scoped user-to-server access token to create a repository scoped and/or |
GET | /apps/{app_slug} | Get an app **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on th |
GET | /codes_of_conduct | Get all codes of conduct codes-of-conduct |
GET | /codes_of_conduct/{key} | Get a code of conduct codes-of-conduct |
GET | /emojis | Get emojis Lists all the emojis available to use on GitHub. emojis |
GET | /enterprises/{enterprise}/dependabot/alerts | List Dependabot alerts for an enterprise Lists Dependabot alerts for repositories that are owned by the specif |
GET | /enterprises/{enterprise}/secret-scanning/alerts | List secret scanning alerts for an enterprise Lists secret scanning alerts for eligible repositories in an ent |
GET | /events | List public events We delay the public events feed by five minutes, which means the most recent event returned |
GET | /feeds | Get feeds GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) f |
GET | /gists | List gists for the authenticated user Lists the authenticated user's gists or if called anonymously, this endp |
POST | /gists | Create a gist Allows you to add a new gist with one or more files. **Note:** Don't name your files "gistfile" |
GET | /gists/public | List public gists List public gists sorted by most recently updated to least recently updated. Note: With [pa |
GET | /gists/starred | List starred gists List the authenticated user's starred gists: gists |
GET | /gists/{gist_id} | Get a gist gists |
PATCH | /gists/{gist_id} | Update a gist Allows you to update a gist's description and to update, delete, or rename gist files. Files fro |
DELETE | /gists/{gist_id} | Delete a gist gists |
GET | /gists/{gist_id}/comments | List gist comments gists |
POST | /gists/{gist_id}/comments | Create a gist comment gists |
GET | /gists/{gist_id}/comments/{comment_id} | Get a gist comment gists |
PATCH | /gists/{gist_id}/comments/{comment_id} | Update a gist comment gists |
DELETE | /gists/{gist_id}/comments/{comment_id} | Delete a gist comment gists |
GET | /gists/{gist_id}/commits | List gist commits gists |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | GitHub API Root Get Hypermedia links to resources accessible in GitHub's REST API meta |
GET | /app | Get the authenticated app Returns the GitHub App associated with the authentication credentials used. To see h |
POST | /app-manifests/{code}/conversions | Create a GitHub App from a manifest Use this endpoint to complete the handshake necessary when implementing th |
GET | /app/hook/config | Get a webhook configuration for an app Returns the webhook configuration for a GitHub App. For more informatio |
PATCH | /app/hook/config | Update a webhook configuration for an app Updates the webhook configuration for a GitHub App. For more informa |
GET | /app/hook/deliveries | List deliveries for an app webhook Returns a list of webhook deliveries for the webhook configured for a GitHu |
GET | /app/hook/deliveries/{delivery_id} | Get a delivery for an app webhook Returns a delivery for the webhook configured for a GitHub App. You must us |
POST | /app/hook/deliveries/{delivery_id}/attempts | Redeliver a delivery for an app webhook Redeliver a delivery for the webhook configured for a GitHub App. You |
GET | /app/installations | List installations for the authenticated app You must use a [JWT](https://docs.github.com/apps/building-github |
GET | /app/installations/{installation_id} | Get an installation for the authenticated app Enables an authenticated GitHub App to find an installation's in |
DELETE | /app/installations/{installation_id} | Delete an installation for the authenticated app Uninstalls a GitHub App on a user, organization, or business |
POST | /app/installations/{installation_id}/access_tokens | Create an installation access token for an app Creates an installation access token that enables a GitHub App |
PUT | /app/installations/{installation_id}/suspended | Suspend an app installation Suspends a GitHub App on a user, organization, or business account, which blocks t |
DELETE | /app/installations/{installation_id}/suspended | Unsuspend an app installation Removes a GitHub App installation suspension. You must use a [JWT](https://docs |
DELETE | /applications/{client_id}/grant | Delete an app authorization OAuth application owners can revoke a grant for their OAuth application and a spec |
POST | /applications/{client_id}/token | Check a token OAuth applications can use a special API method for checking OAuth token validity without exceed |
PATCH | /applications/{client_id}/token | Reset a token OAuth applications can use this API method to reset a valid OAuth token without end-user involve |
DELETE | /applications/{client_id}/token | Delete an app token OAuth application owners can revoke a single token for an OAuth application. You must use |
POST | /applications/{client_id}/token/scoped | Create a scoped access token Use a non-scoped user-to-server access token to create a repository scoped and/or |
GET | /apps/{app_slug} | Get an app **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on th |
GET | /codes_of_conduct | Get all codes of conduct codes-of-conduct |
GET | /codes_of_conduct/{key} | Get a code of conduct codes-of-conduct |
GET | /emojis | Get emojis Lists all the emojis available to use on GitHub. emojis |
GET | /enterprises/{enterprise}/dependabot/alerts | List Dependabot alerts for an enterprise Lists Dependabot alerts for repositories that are owned by the specif |
GET | /enterprises/{enterprise}/secret-scanning/alerts | List secret scanning alerts for an enterprise Lists secret scanning alerts for eligible repositories in an ent |
GET | /events | List public events We delay the public events feed by five minutes, which means the most recent event returned |
GET | /feeds | Get feeds GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) f |
GET | /gists | List gists for the authenticated user Lists the authenticated user's gists or if called anonymously, this endp |
POST | /gists | Create a gist Allows you to add a new gist with one or more files. **Note:** Don't name your files "gistfile" |
GET | /gists/public | List public gists List public gists sorted by most recently updated to least recently updated. Note: With [pa |
GET | /gists/starred | List starred gists List the authenticated user's starred gists: gists |
GET | /gists/{gist_id} | Get a gist gists |
PATCH | /gists/{gist_id} | Update a gist Allows you to update a gist's description and to update, delete, or rename gist files. Files fro |
DELETE | /gists/{gist_id} | Delete a gist gists |
GET | /gists/{gist_id}/comments | List gist comments gists |
POST | /gists/{gist_id}/comments | Create a gist comment gists |
GET | /gists/{gist_id}/comments/{comment_id} | Get a gist comment gists |
PATCH | /gists/{gist_id}/comments/{comment_id} | Update a gist comment gists |
DELETE | /gists/{gist_id}/comments/{comment_id} | Delete a gist comment gists |
GET | /gists/{gist_id}/commits | List gist commits gists |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | GitHub API Root Get Hypermedia links to resources accessible in GitHub's REST API meta |
GET | /app | Get the authenticated app Returns the GitHub App associated with the authentication credentials used. To see h |
POST | /app-manifests/{code}/conversions | Create a GitHub App from a manifest Use this endpoint to complete the handshake necessary when implementing th |
GET | /app/hook/config | Get a webhook configuration for an app Returns the webhook configuration for a GitHub App. For more informatio |
PATCH | /app/hook/config | Update a webhook configuration for an app Updates the webhook configuration for a GitHub App. For more informa |
GET | /app/hook/deliveries | List deliveries for an app webhook Returns a list of webhook deliveries for the webhook configured for a GitHu |
GET | /app/hook/deliveries/{delivery_id} | Get a delivery for an app webhook Returns a delivery for the webhook configured for a GitHub App. You must us |
POST | /app/hook/deliveries/{delivery_id}/attempts | Redeliver a delivery for an app webhook Redeliver a delivery for the webhook configured for a GitHub App. You |
GET | /app/installations | List installations for the authenticated app You must use a [JWT](https://docs.github.com/enterprise-cloud@lat |
GET | /app/installations/{installation_id} | Get an installation for the authenticated app Enables an authenticated GitHub App to find an installation's in |
DELETE | /app/installations/{installation_id} | Delete an installation for the authenticated app Uninstalls a GitHub App on a user, organization, or business |
POST | /app/installations/{installation_id}/access_tokens | Create an installation access token for an app Creates an installation access token that enables a GitHub App |
PUT | /app/installations/{installation_id}/suspended | Suspend an app installation Suspends a GitHub App on a user, organization, or business account, which blocks t |
DELETE | /app/installations/{installation_id}/suspended | Unsuspend an app installation Removes a GitHub App installation suspension. You must use a [JWT](https://docs |
DELETE | /applications/{client_id}/grant | Delete an app authorization OAuth application owners can revoke a grant for their OAuth application and a spec |
POST | /applications/{client_id}/token | Check a token OAuth applications can use a special API method for checking OAuth token validity without exceed |
PATCH | /applications/{client_id}/token | Reset a token OAuth applications can use this API method to reset a valid OAuth token without end-user involve |
DELETE | /applications/{client_id}/token | Delete an app token OAuth application owners can revoke a single token for an OAuth application. You must use |
POST | /applications/{client_id}/token/scoped | Create a scoped access token Use a non-scoped user-to-server access token to create a repository scoped and/or |
GET | /apps/{app_slug} | Get an app **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on th |
GET | /codes_of_conduct | Get all codes of conduct codes-of-conduct |
GET | /codes_of_conduct/{key} | Get a code of conduct codes-of-conduct |
GET | /emojis | Get emojis Lists all the emojis available to use on GitHub Enterprise Cloud. emojis |
GET | /enterprise-installation/{enterprise_or_org}/server-statistics | Get GitHub Enterprise Server statistics Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ |
GET | /enterprises/{enterprise}/actions/cache/usage | Get GitHub Actions cache usage for an enterprise Gets the total GitHub Actions cache usage for an enterprise. |
PUT | /enterprises/{enterprise}/actions/oidc/customization/issuer | Set the GitHub Actions OIDC custom issuer policy for an enterprise Sets the GitHub Actions OpenID Connect (OID |
GET | /enterprises/{enterprise}/actions/permissions | Get GitHub Actions permissions for an enterprise Gets the GitHub Actions permissions policy for organizations |
PUT | /enterprises/{enterprise}/actions/permissions | Set GitHub Actions permissions for an enterprise Sets the GitHub Actions permissions policy for organizations |
GET | /enterprises/{enterprise}/actions/permissions/organizations | List selected organizations enabled for GitHub Actions in an enterprise Lists the organizations that are selec |
PUT | /enterprises/{enterprise}/actions/permissions/organizations | Set selected organizations enabled for GitHub Actions in an enterprise Replaces the list of selected organizat |
PUT | /enterprises/{enterprise}/actions/permissions/organizations/{org_id} | Enable a selected organization for GitHub Actions in an enterprise Adds an organization to the list of selecte |
DELETE | /enterprises/{enterprise}/actions/permissions/organizations/{org_id} | Disable a selected organization for GitHub Actions in an enterprise Removes an organization from the list of s |
GET | /enterprises/{enterprise}/actions/permissions/selected-actions | Get allowed actions and reusable workflows for an enterprise Gets the selected actions and reusable workflows |
PUT | /enterprises/{enterprise}/actions/permissions/selected-actions | Set allowed actions and reusable workflows for an enterprise Sets the actions and reusable workflows that are |
GET | /enterprises/{enterprise}/actions/permissions/workflow | Get default workflow permissions for an enterprise Gets the default workflow permissions granted to the `GITHU |
PUT | /enterprises/{enterprise}/actions/permissions/workflow | Set default workflow permissions for an enterprise Sets the default workflow permissions granted to the `GITHU |
GET | /enterprises/{enterprise}/actions/runner-groups | List self-hosted runner groups for an enterprise Lists all self-hosted runner groups for an enterprise. You m |
POST | /enterprises/{enterprise}/actions/runner-groups | Create a self-hosted runner group for an enterprise Creates a new self-hosted runner group for an enterprise. |
GET | /enterprises/{enterprise}/actions/runner-groups/{runner_group_id} | Get a self-hosted runner group for an enterprise Gets a specific self-hosted runner group for an enterprise. |
PATCH | /enterprises/{enterprise}/actions/runner-groups/{runner_group_id} | Update a self-hosted runner group for an enterprise Updates the `name` and `visibility` of a self-hosted runne |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghec/ghec.
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | GitHub API Root Get Hypermedia links to resources accessible in GitHub's REST API meta |
GET | /app | Get the authenticated app Returns the GitHub App associated with the authentication credentials used. To see h |
POST | /app-manifests/{code}/conversions | Create a GitHub App from a manifest Use this endpoint to complete the handshake necessary when implementing th |
GET | /app/hook/config | Get a webhook configuration for an app Returns the webhook configuration for a GitHub App. For more informatio |
PATCH | /app/hook/config | Update a webhook configuration for an app Updates the webhook configuration for a GitHub App. For more informa |
GET | /app/hook/deliveries | List deliveries for an app webhook Returns a list of webhook deliveries for the webhook configured for a GitHu |
GET | /app/hook/deliveries/{delivery_id} | Get a delivery for an app webhook Returns a delivery for the webhook configured for a GitHub App. You must us |
POST | /app/hook/deliveries/{delivery_id}/attempts | Redeliver a delivery for an app webhook Redeliver a delivery for the webhook configured for a GitHub App. You |
GET | /app/installations | List installations for the authenticated app You must use a [JWT](https://docs.github.com/enterprise-cloud@lat |
GET | /app/installations/{installation_id} | Get an installation for the authenticated app Enables an authenticated GitHub App to find an installation's in |
DELETE | /app/installations/{installation_id} | Delete an installation for the authenticated app Uninstalls a GitHub App on a user, organization, or business |
POST | /app/installations/{installation_id}/access_tokens | Create an installation access token for an app Creates an installation access token that enables a GitHub App |
PUT | /app/installations/{installation_id}/suspended | Suspend an app installation Suspends a GitHub App on a user, organization, or business account, which blocks t |
DELETE | /app/installations/{installation_id}/suspended | Unsuspend an app installation Removes a GitHub App installation suspension. You must use a [JWT](https://docs |
DELETE | /applications/{client_id}/grant | Delete an app authorization OAuth application owners can revoke a grant for their OAuth application and a spec |
POST | /applications/{client_id}/token | Check a token OAuth applications can use a special API method for checking OAuth token validity without exceed |
PATCH | /applications/{client_id}/token | Reset a token OAuth applications can use this API method to reset a valid OAuth token without end-user involve |
DELETE | /applications/{client_id}/token | Delete an app token OAuth application owners can revoke a single token for an OAuth application. You must use |
POST | /applications/{client_id}/token/scoped | Create a scoped access token Use a non-scoped user-to-server access token to create a repository scoped and/or |
GET | /apps/{app_slug} | Get an app **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on th |
GET | /codes_of_conduct | Get all codes of conduct codes-of-conduct |
GET | /codes_of_conduct/{key} | Get a code of conduct codes-of-conduct |
GET | /emojis | Get emojis Lists all the emojis available to use on GitHub Enterprise Cloud. emojis |
GET | /enterprise-installation/{enterprise_or_org}/server-statistics | Get GitHub Enterprise Server statistics Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ |
GET | /enterprises/{enterprise}/actions/cache/usage | Get GitHub Actions cache usage for an enterprise Gets the total GitHub Actions cache usage for an enterprise. |
PUT | /enterprises/{enterprise}/actions/oidc/customization/issuer | Set the GitHub Actions OIDC custom issuer policy for an enterprise Sets the GitHub Actions OpenID Connect (OID |
GET | /enterprises/{enterprise}/actions/permissions | Get GitHub Actions permissions for an enterprise Gets the GitHub Actions permissions policy for organizations |
PUT | /enterprises/{enterprise}/actions/permissions | Set GitHub Actions permissions for an enterprise Sets the GitHub Actions permissions policy for organizations |
GET | /enterprises/{enterprise}/actions/permissions/organizations | List selected organizations enabled for GitHub Actions in an enterprise Lists the organizations that are selec |
PUT | /enterprises/{enterprise}/actions/permissions/organizations | Set selected organizations enabled for GitHub Actions in an enterprise Replaces the list of selected organizat |
PUT | /enterprises/{enterprise}/actions/permissions/organizations/{org_id} | Enable a selected organization for GitHub Actions in an enterprise Adds an organization to the list of selecte |
DELETE | /enterprises/{enterprise}/actions/permissions/organizations/{org_id} | Disable a selected organization for GitHub Actions in an enterprise Removes an organization from the list of s |
GET | /enterprises/{enterprise}/actions/permissions/selected-actions | Get allowed actions and reusable workflows for an enterprise Gets the selected actions and reusable workflows |
PUT | /enterprises/{enterprise}/actions/permissions/selected-actions | Set allowed actions and reusable workflows for an enterprise Sets the actions and reusable workflows that are |
GET | /enterprises/{enterprise}/actions/permissions/workflow | Get default workflow permissions for an enterprise Gets the default workflow permissions granted to the `GITHU |
PUT | /enterprises/{enterprise}/actions/permissions/workflow | Set default workflow permissions for an enterprise Sets the default workflow permissions granted to the `GITHU |
GET | /enterprises/{enterprise}/actions/runner-groups | List self-hosted runner groups for an enterprise Lists all self-hosted runner groups for an enterprise. You m |
POST | /enterprises/{enterprise}/actions/runner-groups | Create a self-hosted runner group for an enterprise Creates a new self-hosted runner group for an enterprise. |
GET | /enterprises/{enterprise}/actions/runner-groups/{runner_group_id} | Get a self-hosted runner group for an enterprise Gets a specific self-hosted runner group for an enterprise. |
PATCH | /enterprises/{enterprise}/actions/runner-groups/{runner_group_id} | Update a self-hosted runner group for an enterprise Updates the `name` and `visibility` of a self-hosted runne |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghec/ghec.
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | GitHub API Root Get Hypermedia links to resources accessible in GitHub's REST API meta |
GET | /admin/hooks | List global webhooks enterprise-admin |
POST | /admin/hooks | Create a global webhook enterprise-admin |
GET | /admin/hooks/{hook_id} | Get a global webhook enterprise-admin |
PATCH | /admin/hooks/{hook_id} | Update a global webhook Parameters that are not provided will be overwritten with the default value or removed |
DELETE | /admin/hooks/{hook_id} | Delete a global webhook enterprise-admin |
POST | /admin/hooks/{hook_id}/pings | Ping a global webhook This will trigger a [ping event](https://docs.github.com/[email protected]/webhooks |
GET | /admin/keys | List public keys enterprise-admin |
DELETE | /admin/keys/{key_ids} | Delete a public key enterprise-admin |
PATCH | /admin/ldap/teams/{team_id}/mapping | Update LDAP mapping for a team Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) o |
POST | /admin/ldap/teams/{team_id}/sync | Sync LDAP mapping for a team Note that this API call does not automatically initiate an LDAP sync. Rather, if |
PATCH | /admin/ldap/users/{username}/mapping | Update LDAP mapping for a user enterprise-admin |
POST | /admin/ldap/users/{username}/sync | Sync LDAP mapping for a user Note that this API call does not automatically initiate an LDAP sync. Rather, if |
POST | /admin/organizations | Create an organization enterprise-admin |
PATCH | /admin/organizations/{org} | Update an organization name enterprise-admin |
GET | /admin/pre-receive-environments | List pre-receive environments enterprise-admin |
POST | /admin/pre-receive-environments | Create a pre-receive environment enterprise-admin |
GET | /admin/pre-receive-environments/{pre_receive_environment_id} | Get a pre-receive environment enterprise-admin |
PATCH | /admin/pre-receive-environments/{pre_receive_environment_id} | Update a pre-receive environment You cannot modify the default environment. If you attempt to modify the defau |
DELETE | /admin/pre-receive-environments/{pre_receive_environment_id} | Delete a pre-receive environment If you attempt to delete an environment that cannot be deleted, you will rece |
POST | /admin/pre-receive-environments/{pre_receive_environment_id}/downloads | Start a pre-receive environment download Triggers a new download of the environment tarball from the environme |
GET | /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest | Get the download status for a pre-receive environment In addition to seeing the download status at the "[Get a |
GET | /admin/pre-receive-hooks | List pre-receive hooks enterprise-admin |
POST | /admin/pre-receive-hooks | Create a pre-receive hook enterprise-admin |
GET | /admin/pre-receive-hooks/{pre_receive_hook_id} | Get a pre-receive hook enterprise-admin |
PATCH | /admin/pre-receive-hooks/{pre_receive_hook_id} | Update a pre-receive hook enterprise-admin |
DELETE | /admin/pre-receive-hooks/{pre_receive_hook_id} | Delete a pre-receive hook enterprise-admin |
GET | /admin/tokens | List personal access tokens Lists personal access tokens for all users, including admin users. enterprise-admi |
DELETE | /admin/tokens/{token_id} | Delete a personal access token Deletes a personal access token. Returns a `403 - Forbidden` status when a pers |
POST | /admin/users | Create a user If an external authentication mechanism is used, the login name should match the login name in t |
PATCH | /admin/users/{username} | Update the username for a user enterprise-admin |
DELETE | /admin/users/{username} | Delete a user Deleting a user will delete all their repositories, gists, applications, and personal settings. |
POST | /admin/users/{username}/authorizations | Create an impersonation OAuth token enterprise-admin |
DELETE | /admin/users/{username}/authorizations | Delete an impersonation OAuth token enterprise-admin |
GET | /app | Get the authenticated app Returns the GitHub App associated with the authentication credentials used. To see h |
POST | /app-manifests/{code}/conversions | Create a GitHub App from a manifest Use this endpoint to complete the handshake necessary when implementing th |
GET | /app/installations | List installations for the authenticated app You must use a [JWT](https://docs.github.com/enterprise-server@2. |
GET | /app/installations/{installation_id} | Get an installation for the authenticated app Enables an authenticated GitHub App to find an installation's in |
DELETE | /app/installations/{installation_id} | Delete an installation for the authenticated app Uninstalls a GitHub App on a user, organization, or business |
POST | /app/installations/{installation_id}/access_tokens | Create an installation access token for an app Creates an installation access token that enables a GitHub App |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghes-2.18/
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | GitHub API Root Get Hypermedia links to resources accessible in GitHub's REST API meta |
GET | /admin/hooks | List global webhooks enterprise-admin |
POST | /admin/hooks | Create a global webhook enterprise-admin |
GET | /admin/hooks/{hook_id} | Get a global webhook enterprise-admin |
PATCH | /admin/hooks/{hook_id} | Update a global webhook Parameters that are not provided will be overwritten with the default value or removed |
DELETE | /admin/hooks/{hook_id} | Delete a global webhook enterprise-admin |
POST | /admin/hooks/{hook_id}/pings | Ping a global webhook This will trigger a [ping event](https://docs.github.com/[email protected]/webhooks |
GET | /admin/keys | List public keys enterprise-admin |
DELETE | /admin/keys/{key_ids} | Delete a public key enterprise-admin |
PATCH | /admin/ldap/teams/{team_id}/mapping | Update LDAP mapping for a team Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) o |
POST | /admin/ldap/teams/{team_id}/sync | Sync LDAP mapping for a team Note that this API call does not automatically initiate an LDAP sync. Rather, if |
PATCH | /admin/ldap/users/{username}/mapping | Update LDAP mapping for a user enterprise-admin |
POST | /admin/ldap/users/{username}/sync | Sync LDAP mapping for a user Note that this API call does not automatically initiate an LDAP sync. Rather, if |
POST | /admin/organizations | Create an organization enterprise-admin |
PATCH | /admin/organizations/{org} | Update an organization name enterprise-admin |
GET | /admin/pre-receive-environments | List pre-receive environments enterprise-admin |
POST | /admin/pre-receive-environments | Create a pre-receive environment enterprise-admin |
GET | /admin/pre-receive-environments/{pre_receive_environment_id} | Get a pre-receive environment enterprise-admin |
PATCH | /admin/pre-receive-environments/{pre_receive_environment_id} | Update a pre-receive environment You cannot modify the default environment. If you attempt to modify the defau |
DELETE | /admin/pre-receive-environments/{pre_receive_environment_id} | Delete a pre-receive environment If you attempt to delete an environment that cannot be deleted, you will rece |
POST | /admin/pre-receive-environments/{pre_receive_environment_id}/downloads | Start a pre-receive environment download Triggers a new download of the environment tarball from the environme |
GET | /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest | Get the download status for a pre-receive environment In addition to seeing the download status at the "[Get a |
GET | /admin/pre-receive-hooks | List pre-receive hooks enterprise-admin |
POST | /admin/pre-receive-hooks | Create a pre-receive hook enterprise-admin |
GET | /admin/pre-receive-hooks/{pre_receive_hook_id} | Get a pre-receive hook enterprise-admin |
PATCH | /admin/pre-receive-hooks/{pre_receive_hook_id} | Update a pre-receive hook enterprise-admin |
DELETE | /admin/pre-receive-hooks/{pre_receive_hook_id} | Delete a pre-receive hook enterprise-admin |
GET | /admin/tokens | List personal access tokens Lists personal access tokens for all users, including admin users. enterprise-admi |
DELETE | /admin/tokens/{token_id} | Delete a personal access token Deletes a personal access token. Returns a `403 - Forbidden` status when a pers |
POST | /admin/users | Create a user If an external authentication mechanism is used, the login name should match the login name in t |
PATCH | /admin/users/{username} | Update the username for a user enterprise-admin |
DELETE | /admin/users/{username} | Delete a user Deleting a user will delete all their repositories, gists, applications, and personal settings. |
POST | /admin/users/{username}/authorizations | Create an impersonation OAuth token enterprise-admin |
DELETE | /admin/users/{username}/authorizations | Delete an impersonation OAuth token enterprise-admin |
GET | /app | Get the authenticated app Returns the GitHub App associated with the authentication credentials used. To see h |
POST | /app-manifests/{code}/conversions | Create a GitHub App from a manifest Use this endpoint to complete the handshake necessary when implementing th |
GET | /app/installations | List installations for the authenticated app You must use a [JWT](https://docs.github.com/enterprise-server@2. |
GET | /app/installations/{installation_id} | Get an installation for the authenticated app Enables an authenticated GitHub App to find an installation's in |
DELETE | /app/installations/{installation_id} | Delete an installation for the authenticated app Uninstalls a GitHub App on a user, organization, or business |
POST | /app/installations/{installation_id}/access_tokens | Create an installation access token for an app Creates an installation access token that enables a GitHub App |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghes-2.19/
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|
and 200 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghes-2.20/
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|
and 200 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghes-2.21/
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|
and 200 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghes-2.22/
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|
and 200 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghes-3.0/g
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|
and 200 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghes-3.1/g
GitHub's v3 REST API.
| method | path | what the vendor says it does |
|---|
and 200 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/ghes-3.2/g
and 7 more specification(s) from github.com, all indexed.
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.