The GitHub Enterprise Integration is part of Apiary Pro for GitHub Enterprise users.

Connecting Apiary to a GitHub Enterprise Organization

  1. Sign into your GitHub Enterprise account at http[s]://[hostname]/login.
  2. In the upper right corner of any page, click the account settings (gear) icon.
  3. In the left sidebar, click the name of your organization.
  4. In the left sidebar, click Applications.
  5. In the upper right corner of the Organization applications box, click Register new application.
  6. Fill in the application settings:
    • In the Application name field, type “Apiary”.
    • In the Homepage URL field, type the full URL “https://apiary.io”.
    • In the Authorization callback URL field, type the full URL “https://login.apiary.io/github”.
  7. Click Register application.
  8. At the top of the page, note the Client ID and Client Secret. You will need these for configuring your Apiary Team Settings.
  9. Go to Apiary.
  10. In the upper right corner click at portrait and switch to your organization.
  11. In top toolbar, click at Settings.
  12. Fill in settings:
    • In the URL name field, type your GHE “[URL]”
    • In the API URL name field, type your GHE “[API_URL]” (URL/api/v3 for standard GHE installation). If not set URL above will be used as API URL
    • In the Client Id, type your Client ID
    • In the Client Secret, type your Client Secret

Github Enterprise Settings in Apiary

Github Enterprise behind firewall

Apiary does support whitelisting or tunneling communication to your GHE instance by using @snyk/broker. To use @snyk/broker you need to have broker running behind the firewall in client mode with

  • appropriate accept.json
  • BROKER_SERVER_URL set to https://broker-server.apiary-services.com
  • “[API_URL]” set to https://broker-server.apiary-services.com/broker/BROKER_TOKEN (BROKER_TOKEN as defined in @snyk/broker)

To enable this features, please contact Apiary support.

Was this page useful?
Thank you for the feedback!
What went wrong?