Managing allowed IP addresses for a GitHub App

You can add an IP allow list to your App GitHub to prevent your app from being blocked by an organization's own allow list.

About IP address allow lists for GitHub Apps

Enterprise and organization owners can restrict access to assets by configuring an IP address allow list. This list specifies the IP addresses that are allowed to connect. For more information, see "Managing allowed IP addresses for your organization" and "Enforcing security settings in your enterprise account."

When an organization has an allow list, third-party applications that connect via a App GitHub will be denied access unless both of the following are true:

  • The creator of the App GitHub has configured an allow list for the application that specifies the IP addresses at which their application runs. See below for details of how to do this.
  • The organization owner has chosen to permit the addresses in the App GitHub's allow list to be added to their own allow list. For more information, see "Managing allowed IP addresses for your organization."

Note: The addresses in the IP allow list of a App GitHub only affect requests made by installations of the App GitHub. The automatic addition of a App GitHub's IP address to an organization's allow list does not allow access to a GitHub user who connects from that IP address.

Adding an IP address allow list to a App GitHub

  1. Navigate to your account settings.
    • For a App GitHub owned by a user account, in the upper-right corner of any page, click your profile photo, then click Settings. Settings icon in the user bar
    • For a App GitHub owned by an organization, in the upper-right corner of any page, click your profile photo, then click Your organizations. Then, to the right of the organization, click Settings. Your organizations in the profile menu The settings button
  2. En la barra lateral izquierda, haz clic en Developer settings (Parámetros del desarrollador). Sección Developer settings (Parámetros del programador)
  3. En la barra lateral izquierda, da clic en GitHub Apps. Sección GitHub Apps
  4. Selecciona la GitHub App que quieres modificar. Seleccion de apps
  5. Scroll down to the "IP allow list" section. Basic information section for your GitHub App
  6. Debajo de "Dirección IP", teclea una dirección o un rango de ellas, en notación CIDR. Campo clave para agregar una dirección IP
  7. Debajo de "Descripción", teclea la descripción de la dirección IP o el rango de ellas que se permitirá. Campo clave para agregar un nombre a la dirección IP The description is for your reference and is not used in the allow list of organizations where the App GitHub is installed. Instead, organization allow lists will include "Managed by the NAME GitHub App" as the description.
  8. Haz clic en Add (Agregar). Botón Add allowed ip address (Agregar dirección ip permitida)

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

O, learn how to contribute.