Bitrise

Promote a package from a source deployment to a target deployment. The most recent package in the source deployment is promoted unless package_id is specified.

Rollback a CodePush deployment to its previous version, or to a specific package if package_id is provided.

Update the name of an existing CodePush deployment.

Add a new Release Management connected app to Bitrise. Adding an internal tester grants the App Tester role on the app; removing them later does not revoke it.

Create an outgoing webhook for an app.

Creates a tester group for a Release Management connected app, optionally with its members: 'user_slugs' for internal groups, 'emails' for external ones. Tester groups are used to distribute installable artifacts to testers, who are notified by email either automatically or manually. Adding an internal tester grants the App Tester role on the app; removing them later does not revoke it. A group is notified once per build, so members added afterwards get no email for that build. This endpoint has an elevated access level requirement. Only the owner of the related Bitrise Workspace, a workspace …

Create a new group in a workspace.

Delete all key-value cache items belonging to an app.

Delete an app from Bitrise. When deleting apps belonging to multiple workspaces always confirm that which workspaces' apps the user wants to delete.

Delete a build artifact.

Delete a key-value cache item.

Delete the outgoing webhook of an app.

Finish the setup of a Bitrise app. If this is successful, a build can be triggered via trigger_bitrise_build. If you have access to the repository, decide the project type, the stack ID, and the config to use, based on https://stacks.bitrise.io/, and the config should be also based on the project type.

Generates a signed upload url valid for 1 hour for an installable artifact to be uploaded to Bitrise Release Management. The response will contain an url that can be used to upload an artifact to Bitrise Release Management using a simple curl request with the file data that should be uploaded. The necessary headers and http method will also be in the response. This artifact will need to be processed after upload to be usable. The status of processing can be checked by making another request to a different url giving back the processed status of an installable artifact.

Get the details of a specific app.

Get a specific build artifact.

Get the current Bitrise YML config file of a specified Bitrise app.

Get a specific build of a given app.

Get the bitrise.yml of a build.

Get the build log of a specified build of a Bitrise app.

Get the steps of a specific build of a given app with their status and timing. For failed or aborted steps it includes the failure reason (errors), and for skipped steps why they were skipped (status_reason).

Get the download URL for a cache item.

Gives back a Release Management connected app for the authenticated account.

Gets the processing and upload status of an installable artifact. An artifact will need to be processed after upload to be usable. This endpoint helps understanding when an uploaded installable artifacts becomes usable for later purposes.

Get a pipeline of a given app.

Lists the people who can be added to a tester group, with the slug each of them is added by. Pass 'workspace_slug' to list workspace members before a connected app or a tester group exists, or 'connected_app_id' with 'id' for the candidates of an existing group. Service accounts are never listed. 'already_member' means 'already in that tester group', never 'already a tester on the app', and is always false on the workspace scope.

Gives back the details of the selected tester group.

Gives back a list of testers that has been associated with a tester group related to a specific connected app.

Get details for one workspace

Get the groups in a workspace

Get the members of a workspace

Invite new Bitrise users to a workspace.

List all apps for the currently authenticated user account

Get a list of all build artifacts.

List available stacks with their machine configurations and version information. When a workspace_slug is provided, returns stacks available for that workspace including any custom stacks. When omitted, returns globally available stacks.

List the branches with existing builds of an app's repository.

Gives back a list of test builds for the given build distribution version.

Lists Build Distribution versions. Release Management offers a convenient, secure solution to distribute the builds of your mobile apps to testers without having to engage with either TestFlight or Google Play. Once you have installable artifacts, Bitrise can generate both private and public install links that testers or other stakeholders can use to install the app on real devices via over-the-air installation. Build distribution allows you to define tester groups that can receive notifications about installable artifacts. The email takes the notified testers to the test build page, from wher…

List the workflows of an app.

List all the builds of a specified Bitrise app or all accessible builds.

List the key-value cache items belonging to an app.

List Release Management connected apps available for the authenticated account within a workspace.

List group roles for an app

List Release Management installable artifacts of a connected app available for the authenticated account.

List the outgoing webhooks of an app.

List all pipelines and standalone builds of an app.

Gives back a list of tester groups related to a specific Release Management connected app.

List the workspaces the user has access to

Get user info for the currently authenticated user account

Notifies an internal tester group about a new test build by email.

Rebuild a pipeline.

Add a new app to Bitrise. After this app should be finished on order to be registered completely on Bitrise (via the finish_bitrise_app tool). Before doing this step, try understanding the repository details from the repository URL. This is a two-step process. First, you register the app with the Bitrise API, and then you finish the setup. The first step creates a new app in Bitrise, and the second step configures it with the necessary settings. If the user has multiple workspaces, always prompt the user to choose which one you should use. Don't prompt the user for finishing the app, just do i…

Add an SSH-key to a specific app.

Register an incoming webhook for a specific application.

Replace group roles for an app.

Changes whether public install page should be available for the installable artifact or not.

List inputs of a step with their defaults, allowed values etc.

Find steps for building workflows or step bundles in a Bitrise YML config file. Finds steps based on name, description, tags or maintainers.

Trigger a new build/pipeline for a specified Bitrise app

Update an app. Only app_slug is required, add only fields you wish to update

Update a build artifact.

Update the Bitrise YML config stored on Bitrise. This has no effect if it is stored in the repository.

Updates a connected app.

Update an outgoing webhook for an app. Even if you do not want to change one of the parameters, you still have to provide that parameter as well: simply use its existing value.

Updates the given tester group. The name and the auto notification setting can be updated optionally.

Validate a Bitrise YML config file. Use this tool to verify any changes made in bitrise.yml.