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

유효한 액세스 수준#

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

30 => Developer access
40 => Maintainer access
60 => Admin access

그룹 상속 유형#

그룹 상속을 사용하면 배포 액세스 수준 및 액세스 규칙이 상속된 그룹 멤버십을 고려할 수 있습니다. 그룹 상속 유형은 ProtectedEnvironments::Authorizable::GROUP_INHERITANCE_TYPE으로 정의됩니다. 다음 유형이 인식됩니다:

0 => Direct group membership only (default)
1 => All inherited groups

보호된 환경 목록#

프로젝트에서 보호된 환경 목록을 가져옵니다:

GET /projects/:id/protected_environments

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

응답 예시:

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

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

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

GET /projects/:id/protected_environments/:name

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

응답 예시:

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

단일 환경 보호#

단일 환경을 보호합니다:

POST /projects/:id/protected_environments

deploy_access_levels 및 approval_rules 배열의 요소는 user_id, group_id 또는 access_level 중 하나이어야 하며, {user_id: integer}, {group_id: integer} 또는 {access_level: integer} 형식을 취합니다. 선택적으로 각각에 유효한 그룹 상속 유형 중 하나로 group_inheritance_type을 지정할 수 있습니다.

각 사용자는 프로젝트에 액세스 권한이 있어야 하며, 각 그룹은 이 프로젝트를 공유해야 합니다.

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

응답 예시:

{
   "name": "production",
   "deploy_access_levels": [
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "protected-access-group",
         "user_id": null,
         "group_id": 9899826,
         "group_inheritance_type": 0
      }
   ],
   "required_approval_count": 0,
   "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
      },
      {
         "id": 39,
         "user_id": null,
         "group_id": 135,
         "access_level": null,
         "access_level_description": "security-group",
         "required_approvals": 2,
         "group_inheritance_type": 0
      }
   ]
}

보호된 환경 업데이트#

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

PUT /projects/:id/protected_environments/:name

deploy_access_levels 및 approval_rules 배열의 요소는 user_id, group_id 또는 access_level 중 하나이어야 하며, {user_id: integer}, {group_id: integer} 또는 {access_level: integer} 형식을 취합니다. 선택적으로 각각에 유효한 그룹 상속 유형 중 하나로 group_inheritance_type을 지정할 수 있습니다.

업데이트하려면:

• user_id: 업데이트된 사용자가 프로젝트에 액세스 권한이 있는지 확인합니다. 해당 해시에서 deploy_access_level 또는 approval_rule의 id도 전달해야 합니다.
• group_id: 업데이트된 그룹이 이 프로젝트를 공유하는지 확인합니다. 해당 해시에서 deploy_access_level 또는 approval_rule의 id도 전달해야 합니다.

삭제하려면:

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

예시: deploy_access_level 레코드 생성#

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

응답 예시:

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

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

응답 예시:

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

예시: approval_rule 레코드 생성#

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

응답 예시:

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

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

응답 예시:

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

단일 환경 보호 해제#

주어진 보호된 환경을 보호 해제합니다:

DELETE /projects/:id/protected_environments/:name

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