프로젝트 별칭 API

Tier: Premium, Ultimate Offering: Self-managed, GitLab Dedicated

모든 방법은 관리자 인증이 필요합니다.

모든 프로젝트 별칭 목록 가져오기

모든 프로젝트 별칭의 목록을 가져옵니다:

GET /project_aliases

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

예시 응답:

[
  {
    "id": 1,
    "project_id": 1,
    "name": "gitlab-foss"
  },
  {
    "id": 2,
    "project_id": 2,
    "name": "gitlab"
  }
]

프로젝트 별칭의 세부정보 가져오기

프로젝트 별칭의 세부정보를 가져옵니다:

GET /project_aliases/:name
속성 유형 필수 설명
name string 예 별칭의 이름입니다. 
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/project_aliases/gitlab"

예시 응답:

{
  "id": 1,
  "project_id": 1,
  "name": "gitlab"
}

프로젝트 별칭 만들기

프로젝트에 대한 새로운 별칭을 추가합니다. 성공하면 201 Created로 응답합니다.
별칭이 이미 존재하는 경우와 같은 유효성 검사 오류가 발생하면 400 Bad Request로 응답합니다:

POST /project_aliases
속성 유형 필수 설명
name string 예 별칭의 이름입니다. 고유해야 합니다.
project_id integer 또는 string 예 프로젝트의 ID 또는 경로입니다. 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/project_aliases" \
     --form "project_id=1" \
     --form "name=gitlab"

또는

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --url "https://gitlab.example.com/api/v4/project_aliases" \
     --form "project_id=gitlab-org/gitlab" \
     --form "name=gitlab"

예시 응답:

{
  "id": 1,
  "project_id": 1,
  "name": "gitlab"
}

프로젝트 별칭 삭제

프로젝트 별칭을 제거합니다. 프로젝트 별칭이 존재하면 204로 응답하고, 존재하지 않으면 404로 응답합니다:

DELETE /project_aliases/:name
속성 유형 필수 설명
name string 예 별칭의 이름입니다. 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/project_aliases/gitlab"