アプリの追加と管理
Bitriseでは、APIを使って新しいプロジェクトを追加できます。プロジェクトの追加、SSHキーの生成、プロジェクトの初期設定のセットアップを行います。
また、たとえば1人のユーザーや特定のWorkspaceに属するすべてのプロジェクトを一覧表示することもできます。
APIで新しいアプリを追加するClick to copy link
| エンドポイント | 機能 | アプリのチームで必要なロール |
|---|---|---|
| POST /apps/register | 新しいアプリを追加します。 | 該当なし |
| POST /apps/{app-slug}/register-ssh-key | 特定のアプリにSSHキーを追加します。 | OwnerまたはAdmin |
| POST /apps/{app-slug}/finish | アプリ追加プロセスの最後にアプリケーションを保存します。 | 該当なし |
| POST /apps/{app-slug}/bitrise.yml | アプリケーション用の新しいbitrise.ymlをアップロードします。 | OwnerまたはAdmin |
この手順と例は、SSHのGitURLを使ってプライベートなアプリを追加することを想定しています。HTTPSのGitURLを使ってアプリを追加する場合は、SSHキーの追加を省略できます。
-
registerエンドポイントを呼び出し、必要なパラメータをすべて設定して、アプリを登録します。Gitプロバイダー、リポジトリのURL、プロバイダー上に表示されるリポジトリのslugを設定する必要があります。また、アプリを所有するWorkspaceのslugも追加する必要があります。これは、レガシーな命名規則により
organization_slugパラメータが必要になるためです。curl -X POST -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/register' -d \'{"provider": "github","is_public": false,"organization_slug": "$ORG_SLUG""type": "git","git_repo_slug": "example-repository","git_owner": "api_demo"}'アプリの名前を変更するデフォルトでは、アプリを登録すると、Gitリポジトリの名前が引き継がれます。
別の名前でアプリを追加したい場合は、次の構文を使ってPOSTリクエストに「title」パラメータを追加できます。
curl -X POST -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/register' -d \'{......"title": "string"}'アプリを作成した後で名前を変更する場合は、PATCHリクエストを送信して
appsエンドポイントを呼び出すこともできます。詳しくは、既存のアプリを管理するを参照してください。 -
完了したら、
register-ssh-keyエンドポイントを呼び出して、作成したSSHキーを設定します。これにより、ビルドの実行時にBitriseがリポジトリをクローンできるようになります。秘密鍵と公開鍵の両方のSSHキーを指定する必要があります。なお、秘密鍵を手動でコピーする場合は、すべての改行を
\nでエスケープする必要があります。Gitプロバイダーに公開鍵を自動的に登録するかどうかも設定できます。
is_register_key_into_provider_serviceパラメータをtrueまたはfalseに設定してください。curl -X POST -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/register-ssh-key' -d \'{"auth_ssh_private_key": "your-private-ssh-key","auth_ssh_public_key": "your-public-ssh-key","is_register_key_into_provider_service": false}' -
finishエンドポイントを呼び出して、アプリの登録プロセスを完了します。このエンドポイントでは、アプリの設定を行えます。プロジェクトタイプ 、ビルドの実行対象となるstack(アプリによって異なる場合があります)、初期設定を設定します。
Environment Variablesを設定したり、アプリケーションの所有者となるWorkspaceをすぐに指定したりすることもできます。なお、
modeパラメータはmanualの値に設定する必要があります。curl -X POST -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/finish' -d \'{"project_type": "ios","stack_id": "osx-xcode-13.2.x","config": "default-ios-config","mode": "manual","envs": {"env1": "val1","env2": "val2"},"organization_slug": "e1ec3dea540bcf21"}'
既存のアプリを管理するClick to copy link
| エンドポイント | 機能 | アプリのチームで必要なロール |
|---|---|---|
| GET /apps | アプリの一覧を取得します。 | 任意 |
| GET /apps/{app-slug} | 特定のアプリを取得します。 | 任意 |
| GET /apps/{app-slug}/bitrise.yml | 特定のアプリのbitrise.ymlを取得します。 | OwnerまたはAdmin |
| GET /apps/{app-slug}/branches | アプリのリポジトリのブランチを一覧表示します。 | 任意 |
| GET /organizations/{org-slug}/apps | Workspaceのアプリの一覧を取得します。 | 任意 |
| GET /users/{user-slug}/apps | ユーザーのアプリの一覧を取得します。 | 任意 |
| PATCH /apps/{app-slug} | 既存のアプリのパラメータを更新します | OwnerまたはAdmin |
1つまたは複数のアプリに関するGETリクエストへのレスポンスには、アプリのslug、プロジェクトタイプ、Gitプロバイダー、リポジトリのオーナー、URLが含まれます。
{
"data": [
{
"slug": "eeeeefffff00000",
"title": "sample-app",
"project_type": "android",
"provider": "github",
"repo_owner": "example-user",
"repo_slug": "android-gradle-kotlin-dsl",
"is_disabled": false,
"status": -1,
"is_public": false,
"owner": {
"account_type": "organization",
"name": "Test Org",
"slug": "fffffeeeee00000"
},
"avatar_url": null
},
{
また、任意のアプリの既存のbitrise.ymlファイルをダウンロードすることもできます。レスポンスにはYAML設定全体が含まれます。
既存のアプリのタイトルやデフォルトのGitブランチを変更したいですか?appsエンドポイントのPATCHメソッドを呼び出すことで、既存のアプリのパラメータを更新できます。
Bitrise APIを使って既存のアプリのパラメータを更新するには、アプリのチームでadminまたはownerロールを持っている必要があります。
ユーザーロールとロールのチートシートの全一覧につ いては、アプリチームのユーザーロールを確認してください。
必須パラメータは次のとおりです。
- slug
オプションパラメータは次のとおりです。
- apple_api_credential_slug: 新しいApple APIキーのslug(推奨: 設定にはUIを使用してください)
- apple_credential_user_id: 新しいapple credentialのユーザーID(推奨: 設定にはUIを使用してください)
- apple_credential_user_slug: 新しいapple credentialのuser slug(推奨: 設定にはUIを使用してください)
- default_branch: アプリケーションの新しいdefault branch。
- is_public: アプリケーションを公開表示するかどうかの新しい値。
- repository_url: アプリケーションの新しいリポジトリURL。
- services_credential_user_id: 新しいservice credential user ID(推奨: 設定にはUIを使用してください)。
- title: アプリケーションの新しいタイトル。
リクエスト:
curl -X 'PATCH' 'https://api.bitrise.io/v0.1/apps/THE-APP-SLUG' -H 'accept: application/json' -H 'Authorization: ACCESS-TOKEN' -H 'Content-Type: application/json' -d '{"default_branch": "main", "title": "Example_app_title_3"}'
Workspaceグループのアプリアクセスロールを管理するClick to copy link
Workspaceグループに、Bitrise上のアプリケーションチームへのアクセス権を付与できます。つまり、グループのすべてのメンバーがグループに割り当てられたロールでアプリを操作できるようになります。
GET /apps/{app-slug}/roles/{role-name}エンドポイントを使用すると、アプリのチームで特定のロールを付与されているすべてのグループを一覧表示できます。role-nameパラメータには次の値を指定できます。
owneradminmanagermemberrelease_managerplatform_engineer
この例では、特定のアプリにAdminロールを付与されているWorkspaceグループの一覧を照会しています。
curl -X 'GET' \
'https://api.bitrise.io/v0.1/apps/APP-SLUG/roles/admin' \
-H 'accept: application/json' \
-H 'Authorization: ACCESS-TOKEN'
PUT /apps/{app-slug}/roles/{role-name}エンドポイントを使用すると、既存のWorkspaceグループにアクセス権を付与できます。このエンドポイントには、指定したロールでアクセス権を付与するすべてのグループのslugを含むgroupsオブジェクトが必要です。
このエンドポイントは、アプリのチームで指定したロールを持っていたそれまでのすべてのグループを置き換えます。たとえば、アプリのチームでグループAlphaとBetaにAdminロールを付与するようエンドポイントを呼び出した場合、その後はAlphaとBetaのみがアプリへのAdminアクセス権を持つことになります。それ以前にチームでAdminロールを持っていた別のグループ(ここではDeltaとします)があった場合、そのロールは削除されます。
Workspaceのグループのslugを取得するには、[GET /organizations/{org-slug}/groups](https://api-docs.bitrise.io/#/organizations/organzation-groups-list)エンドポイントを使用してください。
次の例では、複数のグループにAdminアクセス権を付与します。
curl -X 'PUT' \
'https://api.bitrise.io/v0.1/apps/APP-SLUG/roles/admin' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"groups": [
"GROUP-SLUG-1", "GROUP-SLUG-2"
]
}'
APIを使ってアプリを削除するClick to copy link
アプリの削除は取り消せないことに注意してください。一度削除すると、アプリを復元する方法はありません。
Bitrise APIを使ってアプリを削除できます。必須パラメータは、削除するアプリのアプリslugのみです。
curl -X DELETE -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/THE-APP-SLUG'
新しいbitrise.ymlファイルをアップロードするClick to copy link
新しいbitrise.ymlファイルをアップロードするには、アプリのチームでadminまたはownerロールを持っている必要があります。
ユーザーロールとロールのチートシートの全一覧については、Bitrise CIのロールと権限を確認してください。
bitrise.ymlファイルには、ビルドの設定が含まれています。YAML設定全体をPOSTすることで、APIを通じて現在のファイルを変更できます。以下の例では、次のことを行います。
- フォーマットバージョン11の
bitrise.ymlを作成します。 - デフォルトのStepソースとしてBitriseStepライブラリを設定します。
- stackをXcode 14に設定します。
- BITRISE_PROJECT_PATH環境変数が
build.gradleファイルを指すように設定します。 - ScriptStepを追加します。
- アプリのリポジトリの任意のブランチにコードがプッシュされた場合にプライマリWorkflowをトリガーするトリガーマップを作成します。
curl --fail -X POST -H "Authorization: $ACCESS_TOKEN" "https://api.bitrise.io/v0.1/apps/$APP_SLUG/bitrise.yml" -d \
'{
"app_config_datastore_yaml": {
"format_version": 11,
"default_step_lib_source": "https://github.com/bitrise-io/bitrise-steplib.git",
"meta": {
"bitrise.io": {
"stack": "osx-xcode-14.0.x"
}
},
"app": {
"envs": [
{
"BITRISE_PROJECT_PATH": "build.gradle",
"opts": {
"is_expand": false
}
}
]
},
"workflows": {
"primary": {
"steps": [
{
"script@1": {}
}
]
}
},
"trigger_map": [
{
"push_branch": "*",
"workflow": "primary"
}
]
}
}'
このエンドポイントを呼び出すと、アプリの現在のbitrise.ymlファイルが置き換えられます。もちろん、アップロードしたbitrise.ymlはAPI経由でも、Webサイト上でも変更できます。
アプリのbitrise.ymlファイルの場所を変更するClick to copy link
アプリのbitrise.yml設定ファイルは、次の2つの場所に保存できます。
- bitrise.io上。これはすべてのアプリのデフォルト設定です。
- アプリのリポジトリ内。 この方法では、設定ファイルのバージョン管理とメンテナンスを完全に自分で管理できます。bitrise.io上のグラフィカルなWorkflow Editorを使って設定を変更することもできますが、変更をリポジトリにコミットする必要があります。
APIを使って、ファイルの場所を取得したり変更したりできます。
bitrise.ymlファイルの場所に関する両方のエンドポイントは、アプリへの管理者レベルのアクセス権が必要です。
GET/apps/{app-slug}/bitrise.yml/configエンドポイントを使うと、ファイルの場所を取得できます。ここでの場所とは、このエンドポイントを呼び出すことで、ファイルがbitrise.io上とリポジトリ内のどちらに保存されているかがわかるという意味です。このエンドポイントはパラメータを取らず、レスポンスとして次の2つの値のいずれかを返します。
"location": "bitrise.io""location": "repository"
curl -X 'GET' \
'https://api.bitrise.io/v0.1/apps/APP-SLUG/bitrise.yml/config' \
-H 'accept: application/json' \
-H 'Authorization: ACCESS-TOKEN'
PUT/apps/{app-slug}/bitrise.yml/configエンドポイントを使うと、ファイルの場所を変更できます。つまり、設定ファイルをbitrise.io上とリポジトリ内のどちらで探すかをBitriseに伝えられます。このエンドポイントは、JSONオブジェクトで次の2つの値のいずれかを受け取ります。
- 設定ファイルをbitrise.io上に保存する場合は
"location": "bitrise.io"。 - 設定ファイルをリポジトリ内に保存する場合は
"location": "repository"。
場所をrepositoryに変更しても、単にBitriseに対してアプリのリポジトリ内でbitrise.ymlファイルを探すよう指示するだけである点に注意してください。ファイルがリポジトリ内に存在しない場合、このエンドポイントはエラーを返しませんが、Bitriseが設定ファイルを見つけられないため、ビルドを実行できなくなります。
curl -X 'PUT' \
'https://api.bitrise.io/v0.1/apps/APP-SLUG/bitrise.yml/config' \
-H 'accept: application/json' \
-H 'Authorization: ACCESS-TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"location": "bitrise.io"
}'
すべてのアプリのマシンタイプを一括で変更するClick to copy link
| エンドポイント | 機能 | 必要なロール |
|---|---|---|
| PATCH /users/{user-slug}/apps/machine_types | 同じユーザーが所有するすべてのアプリで、指定したマシンタイプを別のタイプに移行します。 | 該当なし |
| PATCH /organizations/{org-slug}/apps/machine_types | 同じWorkspaceが所有するすべてのアプリで、指定したマシンタイプを別のタイプに移行します。 | Workspaceのowner |
Bitrise APIには、ユーザーまたはWorkspaceのいずれかが所有するすべてのアプリについて、あるマシンタイプから別のマシンタイプに切り替えられる2つのエンドポイントが用意されています。これらのエンドポイントは各アプリのbitrise.ymlファイルを解析し、指定したマシンタイプの出現箇所をすべて探して、別のタイプに置き換えます。たとえば、このエンドポイントを使うと、すべてのアプリでM1 MediumからM1 Largeに切り替えられます。
両方のエンドポイントは、2つのパラメータを取ります。
-
from_machine: 切り替え元のマシンタイプ。
-
to_machine: 切り替え先のマシンタイプ。
利用可能なマシンタイプの一覧はこちらで確認できます: Build machineタイプ。
エンドポイントがfrom_machineパラメータで指定されたマシンタイプを見つけられない場合でも、空のmigrated_appsオブジェクトを含む200レスポンスが返されます。
これらのエンドポイントでは、デフォルトのstackとWorkflow固有のstackの両方でマシンタイプを変更できます。
curl -X 'PATCH' \
'https://api.bitrise.io/v0.1/users/USER-SLUG/apps/machine_types' \
-H 'accept: application/json' \
-H 'Authorization: PERSONAL-ACCESS-TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"from_machine": "g2-m1.4core",
"to_machine": "g2-m1.8core"
}'
curl -X 'PATCH' \
'https://api.bitrise.io/v0.1/organizations/WORKSPACE-SLUG/apps/machine_types' \
-H 'accept: application/json' \
-H 'Authorization: PERSONAL-ACCESS-TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"from_machine": "g2.mac.4large",
"to_machine": "g2.mac.4x-large"
}'
{
"message": "The migration was successful.",
"migrated_apps": [
"android-sample (8f41200-e5a5eee17)",
"sample-swift-project (c291b04-784ca8773)",
]
}
アプリの通知を管理するClick to copy link
PATCH/apps/{app-slug}/update-email-notificationsエンドポイントを使用すると、API呼び出しによっていつでもアプリのメール通知設定を変更できます。このエンドポイントは2つのパラメータを取ります。
- on_failure: 失敗したビルドのメール通知設定。
- on_success: 成功したビルドのメール通知設定。
両方のパラメータは、次の3つの値のいずれかを取ります。
always: 常に通知を送信します。never: 通知を送信しません。失敗したビルドと成功したビルドの両方でdefault valueです。change: 同じブランチの前回のビルドと比較してビルドステータスが変化した場合にのみ通知を送信します。
たとえば、前回のビルドが成功していた場合にのみ失敗したビルドの通知を受け取りたい場合は、on_failureパラメータの値をchangeに設定する必要があります(例のAPP-SLUGはアプリのslugに、ACCESS-TOKENは個人用アクセ ストークンに置き換えてください)。
curl -X 'PATCH' \
'https://api.bitrise.io/v0.1/apps/APP-SLUG/update-email-notifications' \
-H 'accept: application/json' \
-H 'Authorization: ACCESS-TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"on_failure": "change",
}'