Skip to main content Skip to complementary content

Pushing an API version to GitHub

Link your API to a GitHub repository and push your API definition in OAS/Swagger or RAML.

Before you begin

  • You have a GitHub account and a repository.
  • Your browser is supported by GitHub (since Internet Explorer 11 is no longer supported by GitHub, this feature is not supported by Talend Cloud API Designer for IE11).


  1. Open the API version that you want to push to GitHub and click Settings.
  2. If your GitHub account is not linked to your Talend Cloud API Designer account yet, click Link your GitHub account.
    GITHUB section of the API Settings view.
  3. In the window that opens, sign in to GitHub and click Authorize Talend to allow Talend Cloud API Designer to access your GitHub account.
    Information noteWarning: If you are using Internet Explorer 11, you will be prompted to upgrade to the latest version of Microsoft Edge, Google Chrome or Firefox.

    Your GitHub account is now linked to your Talend Cloud API Designer account and you can start pushing you API definitions to GitHub.

  4. In your API settings, use the drop-down lists to select the Owner, the Repository, the Branch and the Format, then enter a Path and click Save.
    In the Format drop-down list, you can choose to export your definition with Talend extensions or in an API Gateway compatibility mode.
    Example settings to link the API definition to a GitHub repository.
    Information noteNote: If your API has several versions, each version can have different GitHub settings.
  5. Once your settings are saved, click Push.
    A green dot appears to the right of Push when your project contains changes that have not been pushed to GitHub.
    Screenshot of the project when it contains changes that have not been pushed to GitHub.
  6. Enter a commit message and a tag if needed, then click Push.
    A tag should be unique and should follow these rules:
    • It can contain only alphanumeric characters and the following special characters: _, -, . and /.
    • It cannot start or end with a special character.
    • It cannot contain the following character patterns: .., // and /..


The selected version of your API definition is pushed to your repository. The name of the file generated contains the name of the API and the version.

You can click View on GitHub to open the selected repository.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!