環境API

GitLab16.2 で導入された GitLab CI/CD ジョブトークン認証に対応しました。

環境一覧

指定されたプロジェクトのすべての環境を取得します。

GET /projects/:id/environments
属性種類必須説明
id整数/文字列yesプロジェクトのIDまたはURLエンコードされたパス。
name文字列です。いいえこの名前の環境を返します。search と排他的です。
search文字列です。いいえ検索条件にマッチする環境のリストを返します。nameと排他的です。3文字以上でなければなりません。
states文字列です。いいえ特定の状態にマッチするすべての環境をリストします。指定できる値：available stopping stoppedstate の値が与えられていない場合は、すべての環境を返します。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments?name=review%2Ffix-foo"

応答例

[
  {
    "id": 1,
    "name": "review/fix-foo",
    "slug": "review-fix-foo-dfjre3",
    "external_url": "https://review-fix-foo-dfjre3.gitlab.example.com",
    "state": "available",
    "tier": "development",
    "created_at": "2019-05-25T18:55:13.252Z",
    "updated_at": "2019-05-27T18:55:13.252Z",
    "enable_advanced_logs_querying": false,
    "logs_api_path": "/project/-/logs/k8s.json?environment_name=review%2Ffix-foo"
  }
]

特定の環境の取得 

GET /projects/:id/environments/:environment_id
属性種類必須説明
id整数/文字列yesプロジェクトのIDまたはURLエンコードされたパス。
environment_id整数。yes環境の ID。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1"

レスポンスの例

{
  "id": 1,
  "name": "review/fix-foo",
  "slug": "review-fix-foo-dfjre3",
  "external_url": "https://review-fix-foo-dfjre3.gitlab.example.com",
  "state": "available",
  "tier": "development",
  "created_at": "2019-05-25T18:55:13.252Z",
  "updated_at": "2019-05-27T18:55:13.252Z",
  "enable_advanced_logs_querying": false,
  "logs_api_path": "/project/-/logs/k8s.json?environment_name=review%2Ffix-foo",
  "last_deployment": {
    "id": 100,
    "iid": 34,
    "ref": "fdroid",
    "sha": "416d8ea11849050d3d1f5104cf8cf51053e790ab",
    "created_at": "2019-03-25T18:55:13.252Z",
    "status": "success",
    "user": {
      "id": 1,
      "name": "Administrator",
      "state": "active",
      "username": "root",
      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://localhost:3000/root"
    },
    "deployable": {
      "id": 710,
      "status": "success",
      "stage": "deploy",
      "name": "staging",
      "ref": "fdroid",
      "tag": false,
      "coverage": null,
      "created_at": "2019-03-25T18:55:13.215Z",
      "started_at": "2019-03-25T12:54:50.082Z",
      "finished_at": "2019-03-25T18:55:13.216Z",
      "duration": 21623.13423,
      "project": {
        "ci_job_token_scope_enabled": false
      },
      "user": {
        "id": 1,
        "name": "Administrator",
        "username": "root",
        "state": "active",
        "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
        "web_url": "http://gitlab.dev/root",
        "created_at": "2015-12-21T13:14:24.077Z",
        "bio": null,
        "location": null,
        "public_email": "",
        "skype": "",
        "linkedin": "",
        "twitter": "",
        "website_url": "",
        "organization": null
      },
      "commit": {
        "id": "416d8ea11849050d3d1f5104cf8cf51053e790ab",
        "short_id": "416d8ea1",
        "created_at": "2016-01-02T15:39:18.000Z",
        "parent_ids": [
          "e9a4449c95c64358840902508fc827f1a2eab7df"
        ],
        "title": "Removed fabric to fix #40",
        "message": "Removed fabric to fix #40\n",
        "author_name": "Administrator",
        "author_email": "admin@example.com",
        "authored_date": "2016-01-02T15:39:18.000Z",
        "committer_name": "Administrator",
        "committer_email": "admin@example.com",
        "committed_date": "2016-01-02T15:39:18.000Z"
      },
      "pipeline": {
        "id": 34,
        "sha": "416d8ea11849050d3d1f5104cf8cf51053e790ab",
        "ref": "fdroid",
        "status": "success",
        "web_url": "http://localhost:3000/Commit451/lab-coat/pipelines/34"
      },
      "web_url": "http://localhost:3000/Commit451/lab-coat/-/jobs/710",
      "artifacts": [
        {
          "file_type": "trace",
          "size": 1305,
          "filename": "job.log",
          "file_format": null
        }
      ],
      "runner": null,
      "artifacts_expire_at": null
    }
  }
}

新しい環境の作成

指定した名前とexternal_url で新しい環境を作成します。

環境の作成に成功した場合は201 を返し、パラメータが間違っていた場合は400 を返します。

POST /projects/:id/environments
属性種類必須説明
id整数/文字列yesプロジェクトのIDまたはURLエンコードされたパス。
name文字列です。yes環境の名前。
external_url文字列です。いいえこの環境のリンク先。
tier文字列です。いいえ新しい環境の階層。指定可能な値はproduction,staging,testing,development, およびotherです。
curl --data "name=deploy&external_url=https://deploy.gitlab.example.com" \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments"

応答例

{
  "id": 1,
  "name": "deploy",
  "slug": "deploy",
  "external_url": "https://deploy.gitlab.example.com",
  "state": "available",
  "tier": "production",
  "created_at": "2019-05-25T18:55:13.252Z",
  "updated_at": "2019-05-27T18:55:13.252Z"
}

既存環境の更新

GitLab 16.0 でパラメータname が削除されました。

既存の環境の名前やexternal_url を更新します。

環境の更新に成功した場合は200 を返します。エラーの場合は、ステータスコード400 が返されます。

PUT /projects/:id/environments/:environments_id
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
environment_id整数。yes環境の ID。
external_url文字列です。いいえ新しいexternal_url。
tier文字列です。いいえ新しい環境の階層。指定可能な値はproduction,staging,testing,development, およびotherです。
curl --request PUT --data "external_url=https://staging.gitlab.example.com" \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1"

応答例

{
  "id": 1,
  "name": "staging",
  "slug": "staging",
  "external_url": "https://staging.gitlab.example.com",
  "state": "available",
  "tier": "staging",
  "created_at": "2019-05-25T18:55:13.252Z",
  "updated_at": "2019-05-27T18:55:13.252Z"
}

環境の削除

環境の削除に成功した場合は204 を返し、 環境が存在しない場合は404 を返します。

DELETE /projects/:id/environments/:environment_id
属性種類必須説明
id整数/文字列yesプロジェクトのIDまたはURLエンコードされたパス。
environment_id整数。yes環境の ID。
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1"

複数停止したレビューアプリの削除

GitLab 14.2で導入されました。

レビューアプリフォルダにある、既に停止している複数の環境の削除をスケジュールします。実際の削除は実行から1週間後に行われます。デフォルトでは、30日以上前の環境のみが削除されます。このデフォルトはbefore パラメーターで変更できます。

DELETE /projects/:id/environments/review_apps
属性種類必須説明
id整数/文字列yesプロジェクトのIDまたはURLエンコードされたパス。
beforedatetimeいいえ環境を削除できる日付。デフォルトは 30 日前です。ISO 8601 フォーマット (YYYY-MM-DDTHH:MM:SSZ) で指定します。
limit整数。いいえ削除する環境の最大数。デフォルトは100です。
dry_runbooleanいいえ安全上の理由からデフォルトはtrue です。実際に削除を行わないドライランを実行します。実際に環境を削除するにはfalse に設定します。
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/review_apps"

応答例

{
  "scheduled_entries": [
    {
      "id": 387,
      "name": "review/023f1bce01229c686a73",
      "slug": "review-023f1bce01-3uxznk",
      "external_url": null
    },
    {
      "id": 388,
      "name": "review/85d4c26a388348d3c4c0",
      "slug": "review-85d4c26a38-5giw1c",
      "external_url": null
    }
  ],
  "unprocessable_entries": []
}

環境の停止

環境の停止に成功した場合は200 を返し、環境が存在しない場合は404 を返します。

POST /projects/:id/environments/:environment_id/stop
属性種類必須説明
id整数/文字列yesプロジェクトのIDまたはURLエンコードされたパス。
environment_id整数。yes環境の ID。
forcebooleanいいえ on_stop アクションを実行せずに環境を強制停止します。
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1/stop"

応答例

{
  "id": 1,
  "name": "deploy",
  "slug": "deploy",
  "external_url": "https://deploy.gitlab.example.com",
  "state": "stopped",
  "created_at": "2019-05-25T18:55:13.252Z",
  "updated_at": "2019-05-27T18:55:13.252Z"
}

古い環境の停止

指定された日付より前に最後に修正されたかデプロイされたすべての環境に対して停止要求をイシューします。保護された環境は除きます。stop リクエストが成功した場合は200 を、before date が無効な場合は400 を返します。環境が停止される正確な日時の詳細については、環境の停止を参照してください。

POST /projects/:id/environments/stop_stale
属性種類必須説明
id整数/文字列yesプロジェクトのIDまたはURLエンコードされたパス。
before期日yes指定された日付以前に変更またはデプロイされた環境を停止します。ISO 8601 フォーマット (2019-03-15T08:00:00Z) で指定します。有効な入力は10年前から1週間前です。
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/stop_stale?before=10%2F10%2F2021"

応答例

{
  "message": "Successfully requested stop for all stale environments"
}