동결 기간 API

Tier: Free, Premium, Ultimate

Offering: GitLab.com, Self-managed, GitLab Dedicated

Freeze Periods API를 사용하여 GitLab Freeze Period 항목을 조작할 수 있습니다.

권한 및 보안

Reporter permissions 이상의 권한을 가진 사용자는 Freeze Period API 엔드포인트를 읽을 수 있습니다. 변경할 수 있는 역할은 Maintainer인 사용자만 가능합니다.

동결 기간 목록

created_at 기준으로 오름차순 정렬된 동결 기간의 페이지네이션 목록입니다.

GET /projects/:id/freeze_periods
속성 유형 필수 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL로 인코딩된 경로입니다.

예제 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" "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로 동결 기간 가져오기

주어진 freeze_period_id에 대한 동결 기간을 가져옵니다.

GET /projects/:id/freeze_periods/:freeze_period_id
속성 유형 필수 설명
id 정수 또는 문자열 예 프로젝트의 ID 또는 URL로 인코딩된 경로입니다.
freeze_period_id 정수 예 동결 기간의 ID입니다.

예제 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" "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 문자열 아니오 크론 필드에 대한 시간대이며, 제공되지 않을 경우 기본값은 UTC입니다.

예제 요청:

curl --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" }' \
     --request POST "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 integer 또는 string 예 프로젝트의 ID 또는 URL 인코딩 경로.
freeze_period_id integer 예 동결 기간의 ID.
freeze_start string 아니오 cron 형식의 동결 기간 시작.
freeze_end string 아니오 cron 형식의 동결 기간 종료.
cron_timezone string 아니오 cron 필드에 대한 시간대.

예제 요청:

curl --header 'Content-Type: application/json' --header "PRIVATE-TOKEN: <your_access_token>" \
     --data '{ "freeze_end": "0 8 * * 1" }' \
     --request PUT "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 integer 또는 string 예 프로젝트의 ID 또는 URL 인코딩 경로.
freeze_period_id integer 예 동결 기간의 ID.

예제 요청:

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