create_tester_group
Creates a tester group for a Release Management connected app. Tester groups can be used to distribute installable artifacts to testers automatically. When a new installable artifact is available, the tester groups can either automatically or manually be notified via email. The notification email will contain a link to the installable artifact page for the artifact within Bitrise Release Management. A Release Management connected app can have multiple tester groups. Project team members of the connected app can be selected to be testers and added to the tester group. This endpoint has an elevated access level requirement. Only the owner of the related Bitrise Workspace, a workspace manager or the related project's admin can manage tester groups.
create_workspace_group
Create a new group in a workspace.
delete_all_cache_items
Delete all key-value cache items belonging to an app.
delete_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_artifact
Delete a build artifact.
delete_cache_item
Delete a key-value cache item.
delete_outgoing_webhook
Delete the outgoing webhook of an app.
finish_bitrise_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.
generate_installable_artifact_upload_url
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_app
Get the details of a specific app.
get_artifact
Get a specific build artifact.
get_bitrise_yml
Get the current Bitrise YML config file of a specified Bitrise app.
get_build
Get a specific build of a given app.
get_build_bitrise_yml
Get the bitrise.yml of a build.
get_build_log
Get the build log of a specified build of a Bitrise app.
get_build_steps
Get step statuses of a specific build of a given app.
get_cache_item_download_url
Get the download URL for a cache item.
get_connected_app
Gives back a Release Management connected app for the authenticated account.
get_installable_artifact_upload_and_proc_status
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_pipeline
Get a pipeline of a given app.
get_potential_testers
Gets a list of potential testers whom can be added as testers to a specific tester group. The list consists of Bitrise users having access to the related Release Management connected app.
get_tester_group
Gives back the details of the selected tester group.
get_testers
Gives back a list of testers that has been associated with a tester group related to a specific connected app.
get_workspace
Get details for one workspace
get_workspace_groups
Get the groups in a workspace
get_workspace_members
Get the members of a workspace
invite_member_to_workspace
Invite new Bitrise users to a workspace.
list_apps
List all apps for the currently authenticated user account
list_artifacts
Get a list of all build artifacts.
list_available_stacks
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_branches
List the branches with existing builds of an app's repository.
list_build_distribution_version_test_builds
Gives back a list of test builds for the given build distribution version.
list_build_distribution_versions
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 where they can install the app on their own device. Build distribution versions are the app versions available for testers.
list_build_workflows
List the workflows of an app.
list_builds
List all the builds of a specified Bitrise app or all accessible builds.
list_cache_items
List the key-value cache items belonging to an app.
list_connected_apps
List Release Management connected apps available for the authenticated account within a workspace.
list_group_roles
List group roles for an app
list_installable_artifacts
List Release Management installable artifacts of a connected app available for the authenticated account.
list_outgoing_webhooks
List the outgoing webhooks of an app.
list_pipelines
List all pipelines and standalone builds of an app.
list_tester_groups
Gives back a list of tester groups related to a specific Release Management connected app.
list_workspaces
List the workspaces the user has access to
me
Get user info for the currently authenticated user account
notify_tester_group
Notifies a tester group about a new test build.
rebuild_pipeline
Rebuild a pipeline.
register_app
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 it automatically.
register_ssh_key
Add an SSH-key to a specific app.
register_webhook
Register an incoming webhook for a specific application.
replace_group_roles
Replace group roles for an app.
set_installable_artifact_public_install_page
Changes whether public install page should be available for the installable artifact or not.
step_inputs
List inputs of a step with their defaults, allowed values etc.
step_search
Find steps for building workflows or step bundles in a Bitrise YML config file. Finds steps based on name, description, tags or maintainers.
trigger_bitrise_build
Trigger a new build/pipeline for a specified Bitrise app
update_app
Update an app. Only app_slug is required, add only fields you wish to update
update_artifact
Update a build artifact.
update_bitrise_yml
Update the Bitrise YML config stored on Bitrise. This has no effect if it is stored in the repository.
update_connected_app
Updates a connected app.
update_outgoing_webhook
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.
update_tester_group
Updates the given tester group. The name and the auto notification setting can be updated optionally.
validate_bitrise_yml
Validate a Bitrise YML config file. Use this tool to verify any changes made in bitrise.yml.