APIIDA API Gateway Manager

Integration: GitLab and GitHub

The integrations listed in the category “Repositories” allow the search for API repositories during the registration process. After sucessfully creating an integration with your version control server, existing repositories can be registered by clicking on the APIs menu (sidemenu) > "Register API" > GitHub/GitLab and selecting the repository from the list in the following screen.

Note: If your repository is empty or the Gateway Manager does not recognize the content as an API or a Layer7 API Gateway resource, a corresponding error message is shown.

Description of input fields

Name

The name is a simple description of the integration. The name is displayed in the list of existing integrations so that the user can identify each integration while viewing the list.

URL

The URL field is used to define the base domain of the server where the repositories are stored. The path to a specific repository will be discovered during the registration process.

Example: If the address of your GitLab repository looks like this “https://mygitlabserver.com/testgroup/devteam1/testproj.git”, the correct value to enter is “https://mygitlabserver.com”.

AccessToken and Credentials

The reason the Gateway Manager requires both credential types:

  • The access token is required for any git api calls to scan the server for available respositories

  • The created credentials (SSH (Key) or HTTPS (Username/Password)) are required to access an individual respository for performing operations (e.g. push/pull to/from the repository)

Filter (GitHub / GitLab)

If the specified access token allows the listing of a range of repositories beyond the scope of repositories which should be listed within the Gateway Manager, the filter field can be used to filter for limit the list of repositories which are listed during the registration process. The filter uses the corresponding search APIs. An empty field applies no filter.

More information can be obtained by looking at the specific documentations:

Examples

GitHub

GitLab