フリーズ期間API

プラン: Free、Premium、Ultimate
提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、デプロイフリーズ期間を操作します。

フリーズ期間を一覧表示

フリーズ期間を昇順にソートしたページ分けされたリストcreated_at

前提条件:

プロジェクトのレポーター、デベロッパー、メンテナー、またはオーナーロールが必要です。

GET /projects/:id/freeze_periods

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。

リクエストの例:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/19/freeze_periods"

レスポンス例:

[
   {
      "id":1,
      "freeze_start":"0 23 * * 5",
      "freeze_end":"0 8 * * 1",
      "cron_timezone":"UTC",
      "created_at":"2020-05-15T17:03:35.702Z",
      "updated_at":"2020-05-15T17:06:41.566Z"
   }
]

フリーズ期間を取得する

指定されたfreeze_period_idのフリーズ期間を取得します。

前提条件:

プロジェクトのレポーター、デベロッパー、メンテナー、またはオーナーロールが必要です。

GET /projects/:id/freeze_periods/:freeze_period_id

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`freeze_period_id`	整数	はい	フリーズ期間のID。

リクエストの例:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/19/freeze_periods/1"

レスポンス例:

{
   "id":1,
   "freeze_start":"0 23 * * 5",
   "freeze_end":"0 8 * * 1",
   "cron_timezone":"UTC",
   "created_at":"2020-05-15T17:03:35.702Z",
   "updated_at":"2020-05-15T17:06:41.566Z"
}

フリーズ期間を作成

指定されたプロジェクトのフリーズ期間を作成します。

前提条件:

プロジェクトのメンテナーまたはオーナーロールが必要です。

POST /projects/:id/freeze_periods

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`freeze_start`	文字列	はい	cron形式のフリーズ期間の開始時刻。
`freeze_end`	文字列	はい	cron形式のフリーズ期間の終了時刻。
`cron_timezone`	文字列	いいえ	cronフィールドのタイムゾーン。指定しない場合はUTCにデフォルト設定されます。

リクエストの例:

curl --request POST \
  --header 'Content-Type: application/json' \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --data '{ "freeze_start": "0 23 * * 5", "freeze_end": "0 7 * * 1", "cron_timezone": "UTC" }' \
  --url "https://gitlab.example.com/api/v4/projects/19/freeze_periods"

レスポンス例:

{
   "id":1,
   "freeze_start":"0 23 * * 5",
   "freeze_end":"0 7 * * 1",
   "cron_timezone":"UTC",
   "created_at":"2020-05-15T17:03:35.702Z",
   "updated_at":"2020-05-15T17:03:35.702Z"
}

フリーズ期間を更新

指定されたfreeze_period_idのフリーズ期間を更新します。

前提条件:

プロジェクトのメンテナーまたはオーナーロールが必要です。

PUT /projects/:id/freeze_periods/:freeze_period_id

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`freeze_period_id`	整数	はい	フリーズ期間のID。
`freeze_start`	文字列	いいえ	cron形式のフリーズ期間の開始時刻。
`freeze_end`	文字列	いいえ	cron形式のフリーズ期間の終了時刻。
`cron_timezone`	文字列	いいえ	cronフィールドのタイムゾーン。

リクエストの例:

curl --request PUT \
  --header 'Content-Type: application/json' \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --data '{ "freeze_end": "0 8 * * 1" }' \
  --url "https://gitlab.example.com/api/v4/projects/19/freeze_periods/1"

レスポンス例:

{
   "id":1,
   "freeze_start":"0 23 * * 5",
   "freeze_end":"0 8 * * 1",
   "cron_timezone":"UTC",
   "created_at":"2020-05-15T17:03:35.702Z",
   "updated_at":"2020-05-15T17:06:41.566Z"
}

フリーズ期間を削除

指定されたfreeze_period_idのフリーズ期間を削除します。

前提条件:

プロジェクトのメンテナーまたはオーナーロールが必要です。

DELETE /projects/:id/freeze_periods/:freeze_period_id

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス。
`freeze_period_id`	整数	はい	フリーズ期間のID。

リクエスト例:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/19/freeze_periods/1"