アプリの追加と管理

1つ以上のアプリに関するGETリクエストへの応答には、アプリスラッグ、そのプロジェクトタイプ、gitプロバイダー、リポジトリの所有者、およびURLが含まれます。

{
  "data": [
    {
      "slug": "eeeeefffff00000",
      "title": "sample-app",
      "project_type": "android",
      "provider": "github",
      "repo_owner": "example-user",
      "repo_url": "[email protected]:example-user/sample-app.git",
      "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 ブランチを変更しますか?の PATCH メソッドを呼び出すことで、既存のアプリのパラメーターを更新できます。apps終点。

必須パラメーターは次のとおりです。

オプションのパラメータは次のとおりです。

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"}'

付与できます ワークスペース グループ Bitrise のアプリケーション チームへのアクセス。これは、グループのすべてのメンバーがアプリで作業できることを意味します グループに割り当てられた役割.

を使用して、アプリのチームで特定のロールが付与されているすべてのグループを一覧表示します。 GET /apps/{app-slug}/roles/{role-name} 終点。の 役割名 パラメータは、次の 3 つの可能な値を取ります。

この例では、特定のアプリに管理者ロールが付与されているワークスペース グループのリストをクエリしています。

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} 終点。このエンドポイントには groups 指定されたロールでアクセスが許可されているすべてのグループのスラッグを含むオブジェクト。

次の例では、複数のグループに管理者アクセスを許可します。

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"
  ]
}'

Bitrise API を使用してアプリを削除できます。唯一の必須パラメーターは、削除するアプリのアプリ スラッグです。

curl -X DELETE -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/THE-APP-SLUG' 

アプリの bitrise.yml 構成ファイルは、次の 2 つの場所に保存できます。

API を使用して、ファイルの場所を取得および変更できます。

とともに GET/apps/{app-slug}/bitrise.yml/config エンドポイントで、ファイルの場所を取得できます。ここでの場所は、エンドポイントを呼び出すと、ファイルが bitrise.io に保存されているかリポジトリに保存されているかがわかることを意味します。エンドポイントはパラメーターを使用せず、応答で次の 2 つの値のいずれかを返します。

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 つの値のいずれかを取ります。

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"
}'

Bitrise API は 2 つのエンドポイントを提供し、1 つのエンドポイントを切り替えることができます。 マシンタイプ もう 1 つはユーザーまたはユーザーが所有するすべてのアプリ用です ワークスペース。エンドポイントは、 bitrise.yml 各アプリのファイルで、指定されたマシン タイプが出現するすべてのマシン タイプを検索し、それらを別のタイプに置き換えます。たとえば、このエンドポイントを使用するすべてのアプリで M1 Medium から M1 Large に切り替えることができます。

どちらのエンドポイントも次の 2 つのパラメータを取ります。

利用可能なマシンタイプのリストは次の場所にあります。 マシンタイプを構築する。

エンドポイントが、 マシンから パラメータを指定しても、空の応答を含む 200 応答が返されます。 migrated_apps 物体。

curl -X 'PATCH' \
  'https://api.bitrise.io/v0.1/user/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-m1-max.5core",
  "to_machine": "g2-m1-max.10core"
}'

{
  "message": "The migration was successful.",
  "migrated_apps": [
    "android-sample (8f41200-e5a5eee17)",
    "sample-swift-project (c291b04-784ca8773)",
  ]
}

あなたは変えられる メール通知設定 いつでも API 呼び出しを介してアプリの PATCH/apps/{app-slug}/update-email-notifications 終点。エンドポイントは次の 2 つのパラメーターを取ります。

両方のパラメーターは、次の 3 つの可能な値を取ります。

たとえば、前回のビルドが成功した場合にのみ失敗したビルドの通知を受け取りたい場合は、次の値を設定する必要があります。 on_failure パラメータへ change (例の APP-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",
}'