Sources

Redocly connects to your source control to offer continuous validation and delivery of your:

  • API definitions
  • API reference docs
  • API developer portal

Contact us to learn about what else we can automate.

How it works

Redocly integrates with popular version control services such as GitHub, GitLab, Bitbucket, and Azure Repos. When you open a pull request, or commit and push to these services, Redocly can be notified automatically and perform an action. For example, we can validate your API definition and build a preview of your API reference docs.

While we recommend following a git-ops docs-like-code workflow, we also support other non-git-based sources such as file uploads, URLs, and CI/CD.

Triggers by source types

Version control services (preferred)

Redocly can trigger workflows based on pushed commits, and on opened or changed pull requests.

You can connect to:

  • GitHub
  • GitHub Enterprise
  • Azure Repos
  • GitLab.com
  • GitLab self-managed
  • Bitbucket Cloud
  • Bitbucket self-managed (Server or Data Center)

Security settings for version control services

When you connect your source to Redocly Workflows, our app will send requests to your version control service from specific IP addresses.

If you're using IP address protection as a security measure in your version control service, add the following IP addresses to your allowlist:

52.206.6.186
3.66.108.62

Allowing these addresses will ensure that Redocly Workflows can access your project repositories and run builds based on changes you and your contributors make.

CI/CD with OpenAPI CLI push

To maintain your API definitions from the CI without allowing Redocly to access your repositories, you can integrate our OpenAPI CLI push command into your pipeline and use it as a source.

File upload

Redocly can run the workflows on demand, when you upload the file(s).

URL source

Redocly can poll a URL at regular intervals. If there is a change, Redocly will validate, bundle, add it to the registry, and trigger the workflow.