{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Apps API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Apps", "type": "folder" }, "items": [ { "info": { "name": "APIs.io Engineering Platform Get the authenticated app", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform Create a GitHub App from a manifest", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/app-manifests/:code/conversions", "params": [ { "name": "code", "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": "APIs.io Engineering Platform Get a webhook configuration for an app", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform Update a webhook configuration for an app", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform List deliveries for an app webhook", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/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": "", "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": "APIs.io Engineering Platform Get a delivery for an app webhook", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform Redeliver a delivery for an app webhook", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform List installation requests for the authenticated app", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform List installations for the authenticated app", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/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": "", "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": "APIs.io Engineering Platform Get an installation for the authenticated app", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform Delete an installation for the authenticated app", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform Create an installation access token for an app", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform Suspend an app installation", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform Unsuspend an app installation", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform Delete an app authorization", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/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 provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](ht" }, { "info": { "name": "APIs.io Engineering Platform Check a token", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/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. Invalid tokens will return `404 NOT FOUND`." }, { "info": { "name": "APIs.io Engineering Platform Reset a token", "type": "http" }, "http": { "method": "PATCH", "url": "http://apigateway.{region}.amazonaws.com/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. Invalid tokens will return `404 NOT FOUND`." }, { "info": { "name": "APIs.io Engineering Platform Delete an app token", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/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." }, { "info": { "name": "APIs.io Engineering Platform Create a scoped access token", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/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`." }, { "info": { "name": "APIs.io Engineering Platform Get an app", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/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": "APIs.io Engineering Platform List repositories accessible to the app installation", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/installation/repositories", "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": "List repositories that an app installation can access." }, { "info": { "name": "APIs.io Engineering Platform Revoke an installation access token", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/installation/token" }, "docs": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce 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](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get an organization installation for the authenticated app", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/orgs/:org/installation", "params": [ { "name": "org", "value": "", "type": "path", "description": "The organization name. The name is not case sensitive." } ] }, "docs": "Enables an authenticated GitHub App to find the organization's installation information.\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": "APIs.io Engineering Platform Get a repository installation for the authenticated app", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/repos/:owner/:repo/installation", "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." } ] }, "docs": "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.\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": "APIs.io Engineering Platform List app installations accessible to the user access token", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/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).\"" } ] }, "docs": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe 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.\n\nYou can find the permissions for the installation under the `permissions` key." }, { "info": { "name": "APIs.io Engineering Platform List repositories accessible to the user access token", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/user/installations/:installation_id/repositories", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." }, { "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": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe 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.\n\nThe access the user has to each repository is included in the hash under the `permissions` key." }, { "info": { "name": "APIs.io Engineering Platform Add a repository to an app installation", "type": "http" }, "http": { "method": "PUT", "url": "http://apigateway.{region}.amazonaws.com/user/installations/:installation_id/repositories/:repository_id", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Add a single repository to an installation. The authenticated user must have admin access to the repository. \n\nThis endpoint only works for PATs (classic) with the `repo` scope." }, { "info": { "name": "APIs.io Engineering Platform Remove a repository from an app installation", "type": "http" }, "http": { "method": "DELETE", "url": "http://apigateway.{region}.amazonaws.com/user/installations/:installation_id/repositories/:repository_id", "params": [ { "name": "installation_id", "value": "", "type": "path", "description": "The unique identifier of the installation." }, { "name": "repository_id", "value": "", "type": "path", "description": "The unique identifier of the repository." } ] }, "docs": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.9/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication)) to access this endpoint." }, { "info": { "name": "APIs.io Engineering Platform Get a user installation for the authenticated app", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/users/:username/installation", "params": [ { "name": "username", "value": "", "type": "path", "description": "The handle for the GitHub user account." } ] }, "docs": "Enables an authenticated GitHub App to find the user’s installation information.\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." } ] } ], "bundled": true }