GitHub

Introduction to the Bitrise API

Japanese translation unavailable

This page has not been translated into Japanese yet - we apologise for the inconvenience! If you’re interested in helping us out, feel free to translate any article in the jp folder of the DevCenter repository and open a PR!

このページは日本語への翻訳がまだ完了しておりません。ご不便をおかけして申し訳ございません! もしお手伝いできる方がいらっしゃれば、ご自由にjpフォルダの記事を日本語に訳していただき、PRを開いてください

Welcome to the Bitrise API! Many of the features that you are used to on our website and with our CLI are available via the API, too. It lets you integrate various systems and services with our CI/CD service for an efficient pipeline.

The API is work-in-progress

The API is work-in-progress: we will add new endpoints and possibly update the existing ones in the future.

You can track the progress of the API: join the discussion! Follow it and get notified about new endpoints and changes, we announce those there.

Feel free to contribute! If you want to request a new API feature or a new endpoint, you can do so!

Bitrise API endpoint documentation

Check out the Bitrise API endpoint reference documentation to see all currently available endpoints and their parameters!

API domain/host and versioning

The Bitrise API’s host is: https://api.bitrise.io/

Every endpoint except the root one is versioned. The version has to be included in the URL right after the host.

Example: https://api.bitrise.io/v0.1/me (requires authentication)

Right now we have only one version, v0.1.

There’s no long term compatibility promise for v0.1, although we try to do our best to not to break anything unless we have to. Once we’re happy with v0.1 we’ll “freeze” it as v1.0, for which we’ll provide long term support.