이 API를 사용하여 그룹 수준 보호된 환경과 상호작용합니다.

유효한 접근 수준#

접근 수준은 ProtectedEnvironments::DeployAccessLevel::ALLOWED_ACCESS_LEVELS 메서드에 정의되어 있습니다. 현재 다음 수준이 인식됩니다:

30 => Developer 접근
40 => Maintainer 접근
60 => Admin 접근

그룹 수준 보호된 환경 목록 조회#

그룹에서 보호된 환경 목록을 가져옵니다.

GET /groups/:id/protected_environments

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/protected_environments/"

응답 예시:

[
   {
      "name":"production",
      "deploy_access_levels":[
         {
            "id": 12,
            "access_level": 40,
            "access_level_description": "Maintainers",
            "user_id": null,
            "group_id": null
         }
      ],
      "required_approval_count": 0
   }
]

단일 보호된 환경 가져오기#

단일 보호된 환경을 가져옵니다.

GET /groups/:id/protected_environments/:name

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/protected_environments/production"

응답 예시:

{
   "name":"production",
   "deploy_access_levels":[
      {
         "id": 12,
         "access_level":40,
         "access_level_description":"Maintainers",
         "user_id":null,
         "group_id":null
      }
   ],
   "required_approval_count": 0
}

단일 환경 보호#

단일 환경을 보호합니다.

POST /groups/:id/protected_environments

할당 가능한 user_id는 Maintainer 역할(또는 그 이상)을 가진 지정된 그룹에 속하는 사용자입니다. 할당 가능한 group_id는 지정된 그룹의 하위 그룹입니다.

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments" \
  --data '{"name": "production", "deploy_access_levels": [{"group_id": 9899826}]}'

응답 예시:

{
   "name":"production",
   "deploy_access_levels":[
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "protected-access-group",
         "user_id": null,
         "group_id": 9899826
      }
   ],
   "required_approval_count": 0
}

다중 승인 규칙을 사용한 예시:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/128/protected_environments" \
  --data '{
    "name": "production",
    "deploy_access_levels": [{"group_id": 138}],
    "approval_rules": [
      {"group_id": 134},
      {"group_id": 135, "required_approvals": 2}
    ]
  }'

이 구성에서 운영자 그룹 "group_id": 138은 QA 그룹 "group_id": 134와 보안 그룹 "group_id": 135가 배포를 승인한 후에만 production에 배포 작업을 실행할 수 있습니다.

보호된 환경 업데이트#

단일 환경을 업데이트합니다.

PUT /groups/:id/protected_environments/:name

업데이트하려면:

• user_id: 업데이트된 사용자가 Maintainer 역할(또는 그 이상)을 가진 지정된 그룹에 속해 있는지 확인합니다. 각 해시에서 deploy_access_level 또는 approval_rule의 id도 전달해야 합니다.
• group_id: 업데이트된 그룹이 이 보호된 환경이 속한 그룹의 하위 그룹인지 확인합니다. 각 해시에서 deploy_access_level 또는 approval_rule의 id도 전달해야 합니다.

삭제하려면:

• _destroy를 true로 설정하여 전달해야 합니다. 다음 예시를 참조하세요.

예시: deploy_access_level 레코드 생성#

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production" \
  --data '{"deploy_access_levels": [{"group_id": 9899829, "access_level": 40}]}'

응답 예시:

{
   "name": "production",
   "deploy_access_levels": [
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "protected-access-group",
         "user_id": null,
         "group_id": 9899829,
         "group_inheritance_type": 1
      }
   ],
   "required_approval_count": 0
}

예시: deploy_access_level 레코드 업데이트#

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production" \
  --data '{"deploy_access_levels": [{"id": 12, "group_id": 22034120}]}'

{
   "name": "production",
   "deploy_access_levels": [
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "protected-access-group",
         "user_id": null,
         "group_id": 22034120,
         "group_inheritance_type": 0
      }
   ],
   "required_approval_count": 2
}

예시: deploy_access_level 레코드 삭제#

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production" \
  --data '{"deploy_access_levels": [{"id": 12, "_destroy": true}]}'

응답 예시:

{
   "name": "production",
   "deploy_access_levels": [],
   "required_approval_count": 0
}

예시: approval_rule 레코드 생성#

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production" \
  --data '{"approval_rules": [{"group_id": 134, "required_approvals": 1}]}'

응답 예시:

{
   "name": "production",
   "approval_rules": [
      {
         "id": 38,
         "user_id": null,
         "group_id": 134,
         "access_level": null,
         "access_level_description": "qa-group",
         "required_approvals": 1,
         "group_inheritance_type": 0
      }
   ]
}

예시: approval_rule 레코드 업데이트#

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production" \
  --data '{"approval_rules": [{"id": 38, "group_id": 135, "required_approvals": 2}]}'

{
   "name": "production",
   "approval_rules": [
      {
         "id": 38,
         "user_id": null,
         "group_id": 135,
         "access_level": null,
         "access_level_description": "security-group",
         "required_approvals": 2,
         "group_inheritance_type": 0
      }
   ]
}

예시: approval_rule 레코드 삭제#

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production" \
  --data '{"approval_rules": [{"id": 38, "_destroy": true}]}'

응답 예시:

{
   "name": "production",
   "approval_rules": []
}

단일 환경 보호 해제#

지정된 보호된 환경의 보호를 해제합니다.

DELETE /groups/:id/protected_environments/:name

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/protected_environments/staging"

응답은 200 코드를 반환해야 합니다.